Bring CI to parity with ChoiceModels and add a documentation build - #66
Merged
Merged
Conversation
Extend the CI workflow with macOS and Windows cells at the forward boundary, a package build job (build, twine check --strict, wheel install and import from outside the tree), and a Sphinx build with warnings treated as errors; set persist-credentials: false on every checkout and print dependency versions in the test jobs. Add a Dependabot configuration for GitHub Actions only. Add a docs extra to pyproject.toml, drop the deprecated theme-path call and the missing _static path from the Sphinx config, and fix a docstring underline that numpydoc rejected, so the documentation now builds cleanly with -W. Update docs/README.md accordingly, replace the static coverage badge in the README with the CI badge, and bump the version to 1.9.dev1.
…ad Sphinx tutorial link
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
1 participant
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.
Summary
Brings Orca's continuous integration up to the standard settled in ChoiceModels 0.3 and UrbanSim 3.3, and gets the documentation building cleanly so it can be checked on every pull request. Part of the maintenance work tracked in #63; groundwork for the automated publishing workflow, which will follow in a separate PR.
ci.yml: the forward boundary (Python 3.14 + latest dependencies) now also runs on macOS and Windows; a new "Package build and install" job builds the sdist and wheel, runstwine check --strict, and installs and imports the wheel from outside the source tree; a new "Documentation build" job runs Sphinx with warnings treated as errors. Every checkout setspersist-credentials: false, and the test jobs print the installed dependency versions. The existing job names (and so the required status checks onmain) are unchanged..github/dependabot.yml: weekly grouped updates for GitHub Actions only, to keep the SHA pins current. No pip entry, sincerequirements-min.txtis a deliberately old constraint set.docsextra inpyproject.toml(Sphinx, the RTD theme, numpydoc);conf.pydrops the deprecatedsphinx_rtd_theme.get_html_theme_path()call and the nonexistent_staticpath; a docstring underline inorca.pythat numpydoc rejected is fixed. With those three changes the docs build with-W.docs/README.mdnow describes the.[docs]install and the strict build command.1.9.dev1; changelog bullet expanded.Verification
sphinx-build -E -W --keep-goingsucceeds (it failed on two warnings before).python -m buildandtwine check --strictpass on the sdist and wheel.actionlintpasses on the workflow.