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
Update Read the Docs configuration and add graphviz
dependency
#1840
Conversation
Thank you for contributing to PlasmaPy! The project's future depends deeply on contributors like you, so we deeply appreciate it! 🌱 The following checklist will be used by the code reviewer to help guide the code review process.
|
Codecov ReportBase: 98.33% // Head: 98.33% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #1840 +/- ##
=======================================
Coverage 98.33% 98.33%
=======================================
Files 95 95
Lines 8343 8343
=======================================
Hits 8204 8204
Misses 139 139 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
sphinx: | ||
fail_on_warning: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This adds the -W --keep-going
flags to the doc build, which are used in the build_docs
tox environment.
graphviz
dependency (see also Broken examples of sphinx.ext.inheritance_diagram sphinx-doc/sphinx#10948 and RTD builder: add graphviz depedendency sphinx-doc/sphinx#11040) in order to fix a problem with inheritance diagrams not showing up in the doc buildfail_on_warning
totrue
which is equivalent to the settings we have for the CI doc buildtox.ini