Skip to content

DOC: Add cross-references from tutorials to API #2449

@VeckoTheGecko

Description

@VeckoTheGecko

This is a tracking issue for cross linking between tutorials and the API documentation.

Files

  • quickstart tutorial ./docs/getting_started/tutorial_quickstart.md
  • output tutorial ./docs/getting_started/tutorial_output.ipynb
  • conceptual workflow ./docs/getting_started/explanation_concepts.md
  • curvilinear grids ./docs/user_guide/examples/tutorial_nemo_curvilinear.ipynb
  • spherical grids and unit conversion ./docs/user_guide/examples/tutorial_unitconverters.ipynb
  • delayed starts ./docs/user_guide/examples/tutorial_delaystart.ipynb
  • kernel loop ./docs/user_guide/examples/explanation_kernelloop.md
  • sampling a field ./docs/user_guide/examples/tutorial_sampling.ipynb
  • StatusCodes ./docs/user_guide/examples/tutorial_statuscodes.md
  • gsw density ./docs/user_guide/examples/tutorial_gsw_density.ipynb
  • Argo float ./docs/user_guide/examples/tutorial_Argofloats.ipynb
  • Diffusion ./docs/user_guide/examples/tutorial_diffusion.ipynb
  • Particle-particle interaction ./docs/user_guide/examples/tutorial_interaction.ipynb
  • Interpolator API ./docs/user_guide/examples/explanation_interpolation.md
  • parcels.interpolators (done in fix formatting in dt guide and interpolators guide #2441 ) src/parcels/interpolators.py
  • timestep and integration method ./docs/user_guide/examples/tutorial_dt_integrators.ipynb

Note that #2448 should probably be worked on first so that we can have richer cross linking

@erikvansebille are there any of these tutorials that need major work (hence should be de-prioritised for cross linking for now)?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions