-
Notifications
You must be signed in to change notification settings - Fork 12
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
Need to run mkdocs
twice.
#7
Labels
documentation
Improvements or additions to documentation
Comments
Thanks for the info! I completely forgot about the double build which I initially saw on the Equinox contributing guidelines. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Super cool to see this project get off the ground!
I just thought I'd give you a heads-up if you're using my doc-building stack, that the
mkdocs
command needs running twice in order to build the documentation correctly. See for example https://github.com/patrick-kidger/diffrax/blob/77bd28b03aafdebcd985d900118ffb900be66d65/.github/workflows/build_docs.yml#L33The TL;DR is that the first call is used to populate a cache of "all documented objects", which is used by the second pass to display their names in the documentation in the desired way.
Whether this is possible with ReadTheDocs I don't know.
FWIW I know the underlying mkdocstrings/pytkdocs stack is being reworked quite substantially, so another approach that may be possible is to rewrite my custom
hackstweaks to fit the new world order. (I've not looked into this at all -- right now I'm just using pinned versions of mkdocstrings+pytkdocs and was planning to figure this out only if something eventually breaks.)The text was updated successfully, but these errors were encountered: