[DOC] Move links to examples into more prominent position#150
Conversation
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the documentation structure to make example links more prominent by adding them to the main navigation tree. The title of the tutorial examples section is shortened for brevity, and the getting started page is reordered to prioritize the Python library usage over CLI usage.
Changes:
- Added direct links to tutorial and how-to examples in the main index toctree for more prominent navigation
- Reordered the "Getting started" page to list Python library usage first, with both options numbered as "1."
- Shortened the tutorial examples section title from "Tutorials: getting started with the pyAFQ Python library" to "Tutorials: Getting started"
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/source/index.rst | Added tutorials/tutorial_examples/index and howto/howto_examples/index to the hidden toctree for improved navigation |
| docs/source/tutorials/index.rst | Reorganized the two methods of using pyAFQ, placing library usage first and renumbering both to "1." |
| examples/tutorial_examples/README.rst | Shortened section title and capitalized "Getting" for consistency |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| tutorials/tutorial_examples/index | ||
| howto/howto_examples/index |
There was a problem hiding this comment.
The paths reference tutorials/tutorial_examples/index and howto/howto_examples/index, which appear to point to sphinx-gallery generated directories. However, sphinx-gallery generates these directories at build time. If these directories don't exist in the source tree before the build, this could cause Sphinx warnings or errors during documentation builds. Verify that sphinx-gallery generates these index files before Sphinx processes the main toctree, or consider whether these entries should be added programmatically or if they're redundant with the entries already present in guides_index.rst.
| tutorials/tutorial_examples/index | |
| howto/howto_examples/index |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There are now links to the examples both in the old positions within the user guide, and on the top header.
