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 docs - merge first ? #9

Merged
merged 25 commits into from
Mar 11, 2024
Merged

Add docs - merge first ? #9

merged 25 commits into from
Mar 11, 2024

Conversation

HaleySchuhl
Copy link
Contributor

@HaleySchuhl HaleySchuhl commented Mar 6, 2024

Describe your changes
Create structure to build a documentation page on ReadTheDocs with a few basic pages to start.

Type of update
Is this a:

  • Update to documentation

Associated 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 self-assigned this Mar 6, 2024
Copy link

deepsource-io bot commented Mar 6, 2024

Here's the code health analysis summary for commits 32922ef..11f0983. 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.

@HaleySchuhl HaleySchuhl added documentation Documentation issues or features ready to review Ready for code review labels Mar 6, 2024
@HaleySchuhl HaleySchuhl requested a review from nfahlgren March 6, 2024 20:29
docs/index.md Outdated Show resolved Hide resolved
docs/documentation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
remove repetitive chunks and reference installation docs from main package
@HaleySchuhl HaleySchuhl requested a review from nfahlgren March 8, 2024 14:39
@HaleySchuhl HaleySchuhl changed the title Add docs Add docs - merge first ? Mar 8, 2024
Copy link
Member

@nfahlgren nfahlgren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are links to files that do not exist, these are easy to flag by building the documentation locally using mkdocs serve --theme readthedocs

Screenshot 2024-03-09 at 12 28 40 PM

docs/documentation.md Outdated Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
@HaleySchuhl HaleySchuhl added work in progress Mark work in progress and removed ready to review Ready for code review labels Mar 11, 2024
remove nonexistent files
remove nonexistent files
remove Points.md doesnt exist yet
create skeleton of doc page for the Points annotation functionality
add Points back in for structure
add current attributes
typo in contrbuting
docs/CONTRIBUTING.md Outdated Show resolved Hide resolved
remove Other Packages
@HaleySchuhl HaleySchuhl added ready to review Ready for code review and removed work in progress Mark work in progress labels Mar 11, 2024
@HaleySchuhl HaleySchuhl requested a review from nfahlgren March 11, 2024 20:19
Equivalent to the PlantCV updating.md file
@nfahlgren nfahlgren merged commit 19da7e5 into main Mar 11, 2024
5 checks passed
@nfahlgren nfahlgren deleted the add_docs branch March 11, 2024 21:01
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 Ready for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Documentation
2 participants