feat(docs): generate docs/examples.rst automatically from docstrings #516
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
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
In this PR, the comments describing each example are moved from
docs/user_guide.rstto a docstring in the correspondingrun.py. Then, a function is added totools/docs_utils.pywhich generatesdocs/examples.rstduring the build of the docs (as it is currently done withdocs/release_notes.rst).Note that 'Examples' is added as a section in the Documentation, instead of being a subsection of the User Guide.
When the VCs are split from the main repo (see #511), this same procedure can be used along with
vc_list.jsonto automatically add the examples of the VCs.BTW, two examples are currently undocumented:
coverageandthird_party_integration. Should we enforce all the examples to have some comment by adding a test?