Infra: add justfile for extensions docs build #195
Conversation
| cp docs/pytket-docs-theming/pyproject.toml docs | ||
| cp docs/pytket-docs-theming/uv.lock docs | ||
|
|
||
| PROJECT_NAME := `(basename $(pwd))` |
There was a problem hiding this comment.
I have only set the name in the project title here. Its quite annoying to get the package verison out of the uv environment.
Should be doable as part of the build recipe
There was a problem hiding this comment.
We could just set the name and get the version from pip?
docs/pytket-docs-theming
Outdated
There was a problem hiding this comment.
Using a branch now for testing -> CQCL/pytket-docs-theming#20
| coverage: install | ||
| cd docs && uv run sphinx-build -v -b coverage . build/coverage | ||
|
|
||
| build-strict: install |
There was a problem hiding this comment.
This is the strict recipe that will run in C.I. It will fail on warnings, broken links and bad coverage.
| cd docs && uv run sphinx-build {{SPHINX_ARGS}} -b html . build -D html_title={{PROJECT_NAME}} | ||
|
|
||
| linkcheck: install | ||
| cd docs && uv run sphinx-build -b linkcheck . build |
There was a problem hiding this comment.
Arguably when this jsutfile is included in the docs theming submodule we can just have users put it into the docs directory and remove all of these cd commands.
| @@ -14,3 +14,6 @@ pytket/extensions/braket/_metadata.py | |||
| .DS_Store | |||
| docs/pyproject.toml | |||
| docs/poetry.lock | |||
| docs/uv.lock | |||
There was a problem hiding this comment.
Do you want to use the uv file at the central website deployment?
| cp docs/pytket-docs-theming/pyproject.toml docs | ||
| cp docs/pytket-docs-theming/uv.lock docs | ||
|
|
||
| PROJECT_NAME := `(basename $(pwd))` |
There was a problem hiding this comment.
We could just set the name and get the version from pip?
Initial work on coming up with a justfile that should live in
pytket-docs-themingMy intention is that the
build-strictrecipe is used in C.I. to catch any broken links, warnings, bad coverage etc.People building the docs locally will just use
just buildandjust serve.