Moving to doctest examples #201
Merged
Conversation
This file contains 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
agoscinski
force-pushed
the
moving-to-doctest
branch
2 times, most recently
from
50629d0 to
05eb63a
Compare
* adapt existing code blocks because they did not work * change the sphinx documentation of classes to autoclass to include the doctest examples in the docs and additional information * remove reference to GreedySelector is this is more developer doc
agoscinski
force-pushed
the
moving-to-doctest
branch
from
05eb63a to
12ffc9c
Compare
|
Works for me! Will review when it's ready. |
|
Its ready |
saswatnayak1998
approved these changes
Aug 7, 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.
Most if it is rather straightforward. Still need to change some existing code blocks. But I also need to change the way the python API is embedded into the doc to include the doctest which is in the python code. See change
@rosecers Are you okay with this? Check out https://scikit-matter--201.org.readthedocs.build/en/201/selection.html#cur
Then I continue doing it for the other classes.
📚 Documentation preview 📚: https://scikit-matter--201.org.readthedocs.build/en/201/