Add extra table of contents links #1326
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Functions are organized by common purpose or data type. For example, all analysis functions are organized in
plantcv.analyze
. The documentation TOC follows this logic, but in some cases it is useful to also link to a function based on a shared set of functionality, such as all functions related to Hyperspectral image analysis.This PR adds duplicate links to the TOC of the documents so that functions can be found both in their actual submodule but also in relevant groupings based on function. In particular, duplicate links are added to the
hyperspectral
andphotosynthesis
sections, and a newInputs and Outputs
section is added at the top to make the basic data handling functions easier to find.Type of update
Is this a: Update to documentation
For the reviewer
See this page for instructions on how to review the pull request.
plantcv/mkdocs.yml
updating.md