PySymGym

Documentation navigation map: start here to find your way around the project.

README.md is the entrypoint for navigating the project. This page is the map: it lists every documentation page, grouped by area, with a brief description. The map is generated from the :description: and :group: metadata at the top of each page (and the description is rendered as the page’s opening line). To register a page, give it that metadata and add it to the hidden toctree below; the docs build fails without valid metadata or with a stale README link. The documentation skill says what to update when code changes.

The published documentation is hosted at pysymgym.github.io/PySymGym.

Documentation map