Add linting and tests for docstring and documentation code #184
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Luthaf
reviewed
Apr 11, 2023
PicoCentauri
force-pushed
the
blackdoc
branch
3 times, most recently
from
26f89e7 to
630083d
Compare
PicoCentauri
changed the title
rosecers
reviewed
Apr 12, 2023
| @@ -1,3 +1,4 @@ | |||
| sphinx | |||
| sphinx_rtd_theme | |||
| sphinx-gallery | |||
| sphinx-toggleprompt | |||
rosecers
approved these changes
Apr 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As given in the title code example blocks are now linted with blackdoc and examples with outputs are tested with doctest. I also added a toggle button for easier copying of examples with the help of sphinx-toggleprompt.
Many of the examples of the docs had some minor issues which I corrected. Let me know if I did anything wrong.
📚 Documentation preview 📚: https://scikit-matter--184.org.readthedocs.build/en/184/