Migrate to pyproject.toml and fix docs build #167
Merged
Conversation
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
On the lines of other MeB python projects, migrate SIR build from setup.py to pyproject.toml. Most of the metadata is static, and hence copied from setup.py to pyproject.toml file and remains the same. versioning is the major change. It is now handled automatically by `setuptools_scm`. The other change is the addition of a `.flake8` file because `flake8` doesn't support configuration by pyproject.toml. References: - https://packaging.python.org/en/latest/guides/writing-pyproject-toml/ - https://setuptools-scm.readthedocs.io/en/latest/usage/ - PyCQA/flake8#234
The __version__ is dynamically written by setuptools_scm at project build time, hence build and install the project during docs build to access it without errors in sphinx configuration.
readthedocs has started to obey the theme specified in the project's sphinx configuration since a while. The current sphinx theme configuration of sir docs predates RTD and was not actually not being used for as long as the docs have been on RTD. Update the documentation to explicitly use the RTD theme for docs.
|
ReadTheDocs seems to obey the theme specified in the project's sphinx configuration since a while. The current sphinx theme configuration of sir docs predates RTD. This theme was not actually not being used in RTD docs for a long time. Hence, updated the configuration to explicitly use the RTD theme. For posterity, here is the relic from the past: |
|
Build succeeds https://app.readthedocs.org/projects/sir/builds/28256467/ and documentation at https://sir.readthedocs.io/en/pyproject/. Once the PR/docs are reviewed, I'll delete the build from RTD. |
yvanzo
reviewed
May 22, 2025
Co-authored-by: yvanzo <yvanzo@users.noreply.github.com>
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.
On the lines of other MeB python projects, migrate SIR build from setup.py to pyproject.toml. Most of the metadata is static, and hence copied from setup.py to pyproject.toml file and remains the same.
versioning is the major change. It is now handled automatically by
setuptools_scm. The version is dynamically written by setuptools_scm at project build time, hence the project must also be built and installed during docs build to access the version without errors in sphinx configuration.A
.flake8file is added becauseflake8doesn't support configuration by pyproject.toml yet.References: