More mkdocs options#45
Open
damskii9992 wants to merge 3 commits into
Open
Conversation
damskii9992
added
[scope] enhancement
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This PR adds more quality-of-life stuff to the documentation:
Relative_crossrefs and scoped_crossrefs allows links within docstrings to other methods, like [name][.method] will provide a link within the docs to the method .method of the class, see https://mkdocstrings.github.io/python/usage/configuration/docstrings/#scoped_crossrefs
for information on how to use it.
I also add a filter which is the default filter minus repr and dir since i assume we don't want those methods in our api-reference.
Lastly i add inventories to numpy and scipp. This allows mkdocs to provide links to these libraries whenever their types are encountered and it allows easy references like [array][scipp.array] in the documentation.