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

documentation structure setup #6

Merged
merged 16 commits into from
Apr 11, 2024
Merged

documentation structure setup #6

merged 16 commits into from
Apr 11, 2024

Conversation

HaleySchuhl
Copy link
Contributor

@HaleySchuhl HaleySchuhl commented Mar 8, 2024

Describe your changes
Basic documentation structure setup and a few standard doc pages adapted from PlantCV main package and plantcv.annotate.

Type of update
Is this a:

  • Update to documentation
  • Work in progress

Associated issues
Reference associated issue numbers. Does this pull request close any issues?

Additional context
Add any other context about the problem here.

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

@HaleySchuhl HaleySchuhl added documentation Improvements or additions to documentation Work in Progress labels Mar 8, 2024
@HaleySchuhl HaleySchuhl self-assigned this Mar 8, 2024
Copy link

deepsource-io bot commented Mar 8, 2024

Here's the code health analysis summary for commits 932d28f..908cb5d. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Python LogoPython✅ SuccessView Check ↗
DeepSource Test coverage LogoTest coverage✅ SuccessView Check ↗

Code Coverage Report

MetricAggregatePython
Branch Coverage100%100%
Composite Coverage100%100%
Line Coverage100%100%

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

docs/installation.md Outdated Show resolved Hide resolved
docs/read_geotif.md Outdated Show resolved Hide resolved
docs/documentation.md Show resolved Hide resolved
docs/documentation.md Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@dhiraj-ms dhiraj-ms marked this pull request as draft March 29, 2024 21:47
@dhiraj-ms dhiraj-ms marked this pull request as ready for review March 29, 2024 21:58
@HaleySchuhl HaleySchuhl requested a review from dhiraj-ms April 9, 2024 16:14
@nfahlgren nfahlgren dismissed dhiraj-ms’s stale review April 11, 2024 15:48

I reviewed it myself

@nfahlgren nfahlgren merged commit 2211a07 into main Apr 11, 2024
5 checks passed
@nfahlgren nfahlgren deleted the add-docs branch April 11, 2024 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants