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

Auto-update docs when working on documentation #457

Merged
merged 3 commits into from
Jul 12, 2024

Conversation

kallewesterling
Copy link
Contributor

Summary

Up until now, when rendering documentation, you have had to re-run the make html command every time. This makes it easier.

Fixes #456

Describe your changes

  • Adding in sphinx liveupdate
  • Creating make script
  • Adding developer documentation about this

Reviewer checklist

Please add anything you want reviewers to specifically focus/comment on.

  • Everything looks ok?

Copy link

codecov bot commented Jul 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.83%. Comparing base (ef8067d) to head (087365b).
Report is 10 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #457   +/-   ##
=======================================
  Coverage   62.83%   62.83%           
=======================================
  Files          41       41           
  Lines        6757     6757           
=======================================
  Hits         4246     4246           
  Misses       2511     2511           
Flag Coverage Δ
unittests 62.83% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@rwood-97 rwood-97 left a comment

Choose a reason for hiding this comment

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

Looks good, I added a note about navigating to http://127.0.0.1:8000 if the new tab doesn't open (it didn't for me).

@kallewesterling
Copy link
Contributor Author

Thank you @rwood-97 -- otherwise looks good to merge?

@kallewesterling kallewesterling merged commit f8b7c0f into main Jul 12, 2024
8 checks passed
@kallewesterling kallewesterling deleted the kallewesterling/issue456 branch July 12, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add sphinx-autobuild for ease of developing documentation
2 participants