#189 Add full example pages to the readthedocs#229
Draft
brendanreardon wants to merge 4 commits intov1from
Draft
#189 Add full example pages to the readthedocs#229brendanreardon wants to merge 4 commits intov1from
brendanreardon wants to merge 4 commits intov1from
Conversation
Collaborator
Author
|
This should be merged after #223 so that yaml paths are as anticipated |
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
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.
Link to the corresponding Issue
#189 Docs: Add full examples to readthedocs
Summary of the Pull Request
This is currently a draft pull request used to get early feedback on a documentation enhancement as it is being developed. Here, we add an "Examples" page to readthedocs that has orphan pages to each full example with commentary.
Here is the Build Preview for this branch and Pull Request.
While developing I'll comment progress on the Issue. Once this is ready for formal review, I'll remove the draft status and update this comment.
Pull Request checklist
Required
pre-commit run --all-filesfrom the root directory).pytest tests/from the root directory).Required if the schema or examples were contributed to
def/andjson/files have been recompiled and committed (Runcd schema; make allfrom the root directory).docs/source/)..rstfiles have been registered in the documentation structure.cd docs; make clean watch &from the root directory to compile documentation).