Merged
Conversation
Introduces .readthedocs.yaml for documentation builds and adds a placeholder references.bib file. Updates docs/requirements.txt to include matplotlib, numpy, PyQt5, and qtpy for enhanced documentation capabilities.
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
2 participants
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.
This pull request focuses on transitioning the book deployment process from GitHub Actions to Read the Docs, updating dependencies, and adding configuration files. The most significant changes include removing the GitHub Actions workflow for deploying the book, adding a Read the Docs configuration file, and updating the
docs/requirements.txtfile to include new dependencies.Migration to Read the Docs:
.github/workflows/build_book.yml: Removed the GitHub Actions workflow for deploying the book to GitHub Pages. This includes steps for installing dependencies, building the book, and deploying it..readthedocs.yaml: Added a new Read the Docs configuration file to manage the build process. This file specifies the Python version, Sphinx configuration, and output formats (PDF and EPUB).Dependency Updates:
docs/requirements.txt: Added new dependencies (matplotlib,numpy,PyQt5,qtpy) to support the updated build and functionality requirements.Miscellaneous:
docs/references.bib: Added placeholder YAML front matter to the bibliography file.