Skip to content

docs: Create docs CLI to facilitate different build combinations - #4000

Merged
joelostblom merged 5 commits into
mainfrom
docs/docs-cli
Apr 8, 2026
Merged

joelostblom merged 5 commits into
mainfrom
docs/docs-cli

Conversation

@joelostblom

Copy link
Copy Markdown
Contributor

Continuation of #3998. I think the current amount of available build options for the docs becomes more manageable and flexible with a small CLI wrapper like this. Now we can combine different docs options via flags instead of having unique uv run task ... commands for each combination. I also made it clearer that the most convenient way to develop locally is via

uv run task doc-build -- --clean --no-autosummary --watch

Regarding the implementation, I went with argparse since I didn't want to take on an extra dependency and this is just some internal tooling for relatively self-explanatory options when building the docs. We could have gone with something fancier like cyclopts or typer, but I think this is sufficient for this purpose.

@joelostblom

joelostblom commented Apr 8, 2026 •

Copy link
Copy Markdown
Contributor Author

Again, merging since its internal tooling and tests pass. PR/Issue 4000! 🎉

@joelostblom
joelostblom merged commit 88c4469 into main Apr 8, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant