Skip to content

Fix/doc build jupyter book v1 - #86

Merged
jpn-- merged 4 commits into
ActivitySim:mainfrom
driftlesslabs:fix/doc-build-jupyter-book-v1
Aug 5, 2026
Merged

Fix/doc build jupyter book v1#86
jpn-- merged 4 commits into
ActivitySim:mainfrom
driftlesslabs:fix/doc-build-jupyter-book-v1

Conversation

@jpn--

@jpn-- jpn-- commented Aug 5, 2026

Copy link
Copy Markdown
Member

This pull request updates the documentation deployment workflow to use uv for dependency management and improves deployment flexibility and reliability. The workflow now allows documentation builds to be triggered manually from the Actions UI, and the deployment process is modernized by switching from conda to uv. Additionally, the documentation requirements are clarified to ensure compatibility.

Workflow improvements:

  • The deploy-docs job can now be triggered either by a release tag or manually from the Actions UI using a new deploy_docs input parameter. [1] [2]
  • The PyPI publishing step is restricted to only run on tag pushes from the main repository, preventing accidental publishes from forks or non-tagged pushes.

Dependency management updates:

  • Switched the documentation build process from conda to uv, simplifying the setup and improving caching and reproducibility. This includes updating the setup steps and how dependencies are installed in the workflow.
  • Updated docs/requirements.txt to pin jupyter-book to versions below 2, and added ruamel.yaml as an explicit dependency, ensuring compatibility and completeness for doc builds.

@jpn--
jpn-- merged commit fc175b2 into ActivitySim:main Aug 5, 2026
2 of 13 checks passed
@jpn--
jpn-- deleted the fix/doc-build-jupyter-book-v1 branch August 5, 2026 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant