Revise the documentation structure to make file names comprehensible by renaming index.rst files to meaningful names based on their directories and updating the build script to maintain clean URLs.
Scope of Documentation
Does NOT include
Content changes to the documentation
Does include
Logistical changes to the documentation structure
Updates to the build script
Checklist for Completion
[ ] Work done on a feature branch, eg. documentation-adding-functionality
[ ] Write the required documentation in RST.
[ ] Add any required resource files to a sub-folder
[ ] Run ./docs/build_docs.sh html_only to ensure the documentation builds correctly, inspect the result, and edit as required to achieve a well-formatted document.
[ ] Update the relevant release notes.
[ ] Readable and followable writing, please use a grammar checker + spell checker
[ ] Passes doc8 checks, see the sphinx RST Primer and check out this black-like tool @biosafetylvl5 wrote for auto-formatting RST files: pink
[ ] A PR from your feature branch to main 😊 with @biosafetylvl5 as a reviewer
Due for review on: June 30
Documentation: Changing Documentation Structure
Documentation Task
index.rstfiles to meaningful names based on their directories and updating the build script to maintain clean URLs.Scope of Documentation
Checklist for Completion
./docs/build_docs.sh html_onlyto ensure the documentation builds correctly, inspect the result, and edit as required to achieve a well-formatted document.main😊 with @biosafetylvl5 as a reviewer