setting up for readthedocs

[K20shores]

Replace github pages with readthedocs which automatically tracks different versions.

Because we require doxygen and breathe, we have to make conf.py run cmake to generate the xml for breathe to ingest. This is what breathe suggests

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.63%. Comparing base (5816b12) to head (654c506).
⚠️ Report is 21 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #923   +/-   ##
=======================================
  Coverage   94.63%   94.63%           
=======================================
  Files          68       68           
  Lines        3185     3185           
=======================================
  Hits         3014     3014           
  Misses        171      171           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull request overview

This PR migrates the documentation build/deploy setup toward Read the Docs by adding RTD configuration, a conda environment definition, and adjusting the Sphinx configuration (including generating Doxygen XML during RTD builds).

Changes:

• Add Read the Docs config (.readthedocs.yaml) and a conda environment (environment.yml) for docs builds.
• Update Sphinx config to build Doxygen XML on RTD and switch to pydata-sphinx-theme.
• Remove GitHub Pages deployment workflow and the version switcher JSON.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
environment.yml	Adds a conda environment definition intended for RTD docs builds.
docs/source/conf.py	Adds RTD-specific Doxygen XML generation and updates theme/options/metadata.
docs/source/_static/switcher.json	Removes the version switcher configuration data.
docs/requirements.txt	Switches Sphinx theme dependency to pydata-sphinx-theme.
docker/Dockerfile.docs	Removes some tooling packages from the docs Docker image.
.readthedocs.yaml	Adds RTD build configuration pointing to the conda env and Sphinx config.
.github/workflows/gh_pages.yml	Removes the GitHub Pages docs deployment workflow.

Comments suppressed due to low confidence (1)

docs/source/conf.py:64

• The version parsing opens '../../CMakeLists.txt' via a relative path. Sphinx/Read the Docs often runs with a different working directory, which can make this path invalid. Use an absolute path based on REPO_ROOT_DIR (e.g., join(REPO_ROOT_DIR, 'CMakeLists.txt')) so the version extraction is stable across builders.

regex = r'project\(\w+\s+VERSION\s+(\d+\.\d+\.\d+)'
version = '0.0.0'
# read the version from the cmake files
with open(f'../../CMakeLists.txt', 'r') as f:
    for line in f:

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.