Docs: Improve readability of reference page #605
Merged
+8
−1
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
This uses some (but not all) of the settings recommended at https://mkdocstrings.github.io/python/usage/#recommended-settings. Changes to the "Reference" page: - Replace section heading with function name (instead of function declaration): This should be more readable. - The function declaration is now shown in a code block instead of the heading. - Added "Table of contents" to the right, to quickly navigate to a particular method. - Removed "Source code": It removes clutter from the page and probably wasn't very useful (but it can easily be added back if needed).
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 uses some (but not all) of the settings recommended at https://mkdocstrings.github.io/python/usage/#recommended-settings.
Changes to the "Reference" page: