DOC: Setup Sphinx docs and contribution guidelines#5
Merged
mberz merged 14 commits intoMay 9, 2026
Conversation
74eab6a to
0edc7bf
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a Sphinx documentation site for the simulation-backend, adds end-user setup and contributor guidance pages, and configures Read the Docs to build/host the generated documentation.
Changes:
- Adds Sphinx configuration + docs skeleton (index, setup pages, contributing pages) and enables a sphinx-gallery examples section.
- Updates
pyproject.tomlwith Python requirement plustests/docsoptional dependency groups. - Adds
.readthedocs.ymland supportingdocs/build files (Makefile, make.bat, gitignore) for RTD and local builds.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
pyproject.toml |
Defines Python version requirement and adds tests/docs extras for documentation + tooling. |
docs/source/index.rst |
Adds documentation landing page and top-level navigation. |
docs/source/includes/setup.rst |
Adds setup toctree for end-user setup docs. |
docs/source/includes/setup/required_software.rst |
Documents required local software (Git/Docker/WSL guidance). |
docs/source/includes/setup/setup_user.rst |
Documents user setup steps for CHORAS (including cloud connection guidance). |
docs/source/includes/contributing.rst |
Adds contributing toctree for developer-focused docs. |
docs/source/includes/contributing/setup_dev.rst |
Documents contributor development environment setup steps. |
docs/source/includes/contributing/contribute_method.rst |
Documents how to scaffold and implement a simulation method interface. |
docs/source/includes/contributing/configuring.rst |
Documents how to register/configure a new method and debug execution. |
docs/source/conf.py |
Adds Sphinx configuration (theme, extensions, sphinx-gallery config). |
docs/Makefile |
Adds standard Sphinx Makefile for local doc builds. |
docs/make.bat |
Adds Windows batch script for local doc builds. |
docs/.gitignore |
Ignores generated sphinx-gallery artifacts in docs/. |
.readthedocs.yml |
Configures Read the Docs build environment and installs .[docs]. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Proposed Changes
Rendered documentation can be found here: https://simulation-backend--5.org.readthedocs.build/en/5/