Skip to content

Move example walkthrough from example/ folder into Read the Docs - #64

Merged
harryswift01 merged 1 commit into
mainfrom
63-docs-move-example-walkthrough
Sep 28, 2026
Merged

harryswift01 merged 1 commit into
mainfrom
63-docs-move-example-walkthrough

Conversation

@harryswift01

Copy link
Copy Markdown
Member

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:

  • Added docs/source/examples.rst with the competition calculation walkthrough (command, inputs, outputs)
  • Added examples to index.rst's toctree
  • Input/output files and the figure are available via Sphinx :download: links rather than embedded inline

Move example assets into the docs tree:

  • Moved pbr322.toy.fa, one_line.pbr322.toy.fa, both IRF .html outputs, pbr322.toy.compete.txt, and all.eps into docs/source/_static/examples/
  • Removed the now-empty example/ folder and its README.txt

Update cross references:

  • Updated source-usage.rst's existing "Example calculation" section to point at the new examples page instead of describing the old directory

Impact

  • No behavioural change to SIST itself, this is entirely a documentation move
  • The worked example is now visible to anyone using the published Read the Docs site, not just repo clones

@harryswift01 harryswift01 self-assigned this Sep 28, 2026
@harryswift01 harryswift01 added the documentation Improvements or additions to documentation label Sep 28, 2026

@jimboid jimboid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@harryswift01
harryswift01 merged commit 2c34592 into main Sep 28, 2026
15 checks passed
@harryswift01
harryswift01 deleted the 63-docs-move-example-walkthrough branch September 28, 2026 11:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Move example walkthrough from example/ folder into Read the Docs

2 participants