[infra] Move mkdocs to use poetry as docs group dep
#1486
Conversation
|
blocked on #1485 |
Makefile
Outdated
| @@ -97,3 +97,9 @@ clean: ## Clean up the project Python working environment | |||
| @find . -name "*.pyd" -exec echo Deleting {} \; -delete | |||
| @find . -name "*.pyo" -exec echo Deleting {} \; -delete | |||
| @echo "Cleanup complete" | |||
|
|
|||
| docs: | |||
There was a problem hiding this comment.
Should we call this one docs-serve for completeness?
.github/workflows/python-ci-docs.yml
Outdated
| - name: Build | ||
| working-directory: ./mkdocs | ||
| run: mkdocs build --strict | ||
| run: make install |
There was a problem hiding this comment.
This will probably slow down the runs of the docs builds (since we install everything), do you have any numbers?
There was a problem hiding this comment.
action run for this PR took only 1m 34s
https://github.com/apache/iceberg-python/actions/runs/12623916115?pr=1486
on main this action usually takes ~12m
https://github.com/apache/iceberg-python/actions/workflows/python-ci.yml?query=branch%3Amain
There was a problem hiding this comment.
im not sure if this is apple-to-apple.
alternatively, we can add the mkdoc deps as a new poetry group and just install those
poetry install --with docs
kevinjqliu
changed the title
mkdocs to use poetry as docs group dep
|
moved to poetry as |
There was a problem hiding this comment.
I wasn't aware of the groups function in Poetry, but that seems to fit very nicely here. Thanks @kevinjqliu
Closes #923
docsgroup dependenciespoetry add $(cat mkdocs/requirements.txt | grep -v #) --group docsmake docs-installcommand to install libraries required to run mkdocsmake docs-servecommand to run mkdocs locallymake docs-buildcommand to build mkdocs