Add mkdocs toc config section #858
Merged
Conversation
This file contains hidden or 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
kevinjqliu
reviewed
Jun 26, 2024
Contributor
kevinjqliu
left a comment
kevinjqliu
left a comment
There was a problem hiding this comment.
Thanks for the contribution!
Were you able to manually run the doc server with these changes? It would be great to see if this will create anchors in the docs website.
Here's how to run the doc server
https://github.com/apache/iceberg-python/tree/main/mkdocs
Contributor
Author
|
Yes, I was able to run it locally and it worked. |
Contributor
|
Thank you! Do you mind adding a screenshot of the local docs server with the anchor? |
Contributor
Author
|
Yes, sure, no problem!
|
kevinjqliu
approved these changes
Jun 26, 2024
Contributor
kevinjqliu
left a comment
kevinjqliu
left a comment
There was a problem hiding this comment.
Thanks for the contribution and the screenshot confirming the anchor.
LGTM!
Fokko
approved these changes
Jun 26, 2024
Contributor
|
Thanks @uatach for fixing this! I always used the menu on the right hand side to get an anchored link, which is very awkward. Thanks @kevinjqliu for the great review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Fixes #808
It seems that enabling the
tocextension and itspermalinkoption should enable anchors in the section headers as per https://python-markdown.github.io/extensions/toc/#usage