Skip to content

bring config for readthedocs #422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 19, 2025

Conversation

jo-mueller
Copy link
Member

This pull request removes the GitHub Actions workflow for deploying the Jupyter Book and replaces it with a Read the Docs configuration. Additionally, it updates the Python dependencies to reflect the changes in the build system.

Build system changes:

  • Removed the .github/workflows/build_book.yml file, which contained the GitHub Actions workflow for building and deploying the Jupyter Book to GitHub Pages.
  • Added a readthedocs.yaml configuration file to set up Read the Docs for building and hosting the documentation. This includes specifying the OS, Python version, pre-build steps, and Sphinx configuration.

Dependency updates:

  • Updated docs/requirements.txt to replace QtPy with PyQt5 and qtpy, ensuring compatibility with the new build and deployment process.

@jo-mueller jo-mueller added the documentation Improvements or additions to documentation label Jul 19, 2025
@jo-mueller jo-mueller merged commit ae9eb9e into campaslab:main Jul 19, 2025
9 of 10 checks passed
@jo-mueller jo-mueller deleted the use-readthedocs-for-doc-build branch July 19, 2025 10:52
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
None yet
Development

Successfully merging this pull request may close these issues.

1 participant