Move example walkthrough from example/ folder into Read the Docs - #64
Merged
Merged
Conversation
jimboid
approved these changes
Sep 28, 2026
jimboid
left a comment
Member
There was a problem hiding this comment.
Looks good. I'm not seeing any large diff line numbers so this doesn't suggest the examples are using large files that should be on the file-store, so safe to keep them here.
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.
Summary
This PR moves the worked example walkthrough out of the standalone
example/folder and into the Read the Docs site, so it's discoverable by anyone using the published documentation.Changes
Add a dedicated examples page:
docs/source/examples.rstwith the competition calculation walkthrough (command, inputs, outputs)examplestoindex.rst's toctree:download:links rather than embedded inlineMove example assets into the docs tree:
pbr322.toy.fa,one_line.pbr322.toy.fa, both IRF.htmloutputs,pbr322.toy.compete.txt, andall.epsintodocs/source/_static/examples/example/folder and itsREADME.txtUpdate cross references:
source-usage.rst's existing "Example calculation" section to point at the newexamplespage instead of describing the old directoryImpact