Skip to content

#189 Add full example pages to the readthedocs#229

Draft
brendanreardon wants to merge 4 commits intov1from
189-examples-readthedocs
Draft

#189 Add full example pages to the readthedocs#229
brendanreardon wants to merge 4 commits intov1from
189-examples-readthedocs

Conversation

@brendanreardon
Copy link
Copy Markdown
Collaborator

@brendanreardon brendanreardon commented Apr 23, 2026

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

  • The title of this Pull Request accurately reflects the scope and content of the linked Issue.
  • The branch passes all pre-commit hooks (Run pre-commit run --all-files from the root directory).
  • The branch passes all tests (Run pytest tests/ from the root directory).

Required if the schema or examples were contributed to

  • The schema def/ and json/ files have been recompiled and committed (Run cd schema; make all from the root directory).
  • Tests have been created or updated.
  • Schema changes have been documented (existing files updated or new files created in docs/source/).
  • Any new schema definition .rst files have been registered in the documentation structure.
  • Documentation has been regenerated and committed (Run cd docs; make clean watch & from the root directory to compile documentation).

@brendanreardon brendanreardon requested a review from a team as a code owner April 23, 2026 03:45
@brendanreardon brendanreardon marked this pull request as draft April 23, 2026 03:46
@brendanreardon
Copy link
Copy Markdown
Collaborator Author

This should be merged after #223 so that yaml paths are as anticipated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant