apache / iceberg-python

Apache PyIceberg
https://py.iceberg.apache.org/
Apache License 2.0
309 stars 114 forks source link

Add mkdocs toc config section #858

Closed uatach closed 6 days ago

uatach commented 1 week ago

Fixes #808

It seems that enabling the toc extension and its permalink option should enable anchors in the section headers as per https://python-markdown.github.io/extensions/toc/#usage

uatach commented 6 days ago

Yes, I was able to run it locally and it worked.

kevinjqliu commented 6 days ago

Thank you! Do you mind adding a screenshot of the local docs server with the anchor?

uatach commented 6 days ago

Yes, sure, no problem!

image

Fokko commented 6 days ago

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!