Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add extra table of contents links #1326

Merged
merged 4 commits into from
Aug 11, 2023
Merged

Conversation

nfahlgren
Copy link
Member

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 and photosynthesis sections, and a new Inputs 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.

  • PR functionality reviewed in a Jupyter Notebook
  • All tests pass
  • Test coverage remains 100%
  • Documentation tested
  • New documentation pages added to plantcv/mkdocs.yml
  • Changes to function input/output signatures added to updating.md
  • Code reviewed
  • PR approved

@nfahlgren nfahlgren added documentation Documentation issues or features ready to review labels Aug 10, 2023
@nfahlgren nfahlgren added this to the PlantCV v4.0 milestone Aug 10, 2023
@codecov
Copy link

codecov bot commented Aug 10, 2023

Codecov Report

Merging #1326 (831e043) into release-4.0 (5074924) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff              @@
##           release-4.0     #1326   +/-   ##
=============================================
  Coverage       100.00%   100.00%           
=============================================
  Files              157       157           
  Lines             6777      6777           
=============================================
  Hits              6777      6777           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@nfahlgren nfahlgren merged commit f2eebed into release-4.0 Aug 11, 2023
5 checks passed
@nfahlgren nfahlgren deleted the add-extra-toc-links branch August 11, 2023 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation issues or features ready to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants