-
Notifications
You must be signed in to change notification settings - Fork 211
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[infra] Move mkdocs
to use poetry as docs
group dep
#1486
Merged
Merged
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
5cd255e
poetry add $(cat mkdocs/requirements.txt | grep -v #) --group dev
kevinjqliu 548c3d0
add `make docs`
kevinjqliu c99ac5e
update instructions
kevinjqliu 5312c88
strict mode
kevinjqliu 2f82934
make docs-build
kevinjqliu d76fbb4
docs-serve
kevinjqliu 2eda259
add comment
kevinjqliu be4e24e
add docs as dep group
kevinjqliu 0692ddf
add make install-poetry
kevinjqliu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we call this one |
||
poetry run mkdocs serve -f mkdocs/mkdocs.yml | ||
|
||
docs-build: | ||
poetry run mkdocs build -f mkdocs/mkdocs.yml --strict |
This file contains 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
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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