Skip to content

DOC: Setup Sphinx docs and contribution guidelines#5

Merged
mberz merged 14 commits into
test/implement_method_testsfrom
docs/add_contribution_guidelines
May 9, 2026
Merged

DOC: Setup Sphinx docs and contribution guidelines#5
mberz merged 14 commits into
test/implement_method_testsfrom
docs/add_contribution_guidelines

Conversation

@mberz
Copy link
Copy Markdown
Contributor

@mberz mberz commented May 8, 2026

Proposed Changes

  • Configure Sphinx documentation framework
  • Add contribution guidelines
  • Re-introduce example from backend
  • Configure readthedocs.org to host the documentation

Rendered documentation can be found here: https://simulation-backend--5.org.readthedocs.build/en/5/

@mberz mberz force-pushed the docs/add_contribution_guidelines branch from 74eab6a to 0edc7bf Compare May 8, 2026 22:39
@mberz mberz requested a review from SilvinWillemsen May 8, 2026 23:11
@mberz mberz added the documentation Improvements or additions to documentation label May 8, 2026
@mberz mberz moved this from Backlog to Require review in CHORAS planning May 8, 2026
@mberz mberz marked this pull request as ready for review May 8, 2026 23:12
@mberz mberz requested a review from Copilot May 8, 2026 23:15
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.toml with Python requirement plus tests/docs optional dependency groups.
  • Adds .readthedocs.yml and supporting docs/ 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.

Comment thread pyproject.toml Outdated
Comment thread pyproject.toml Outdated
Comment thread docs/source/includes/setup/setup_user.rst Outdated
Comment thread docs/source/includes/setup/setup_user.rst Outdated
Comment thread docs/source/includes/contributing/configuring.rst Outdated
Comment thread docs/source/includes/contributing/configuring.rst Outdated
Comment thread docs/source/includes/contributing/configuring.rst Outdated
Comment thread docs/source/index.rst Outdated
mberz and others added 3 commits May 9, 2026 08:25
@mberz mberz merged commit 9315098 into test/implement_method_tests May 9, 2026
15 checks passed
@github-project-automation github-project-automation Bot moved this from Require review to Done in CHORAS planning May 9, 2026
@mberz mberz deleted the docs/add_contribution_guidelines branch May 9, 2026 13:05
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

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants