-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enable cross-references on function signatures in documentation
When enabling `signature_crossrefs`, some default values use enumeration values that we'd really like to have anchors for in the documentation. (This also seems sensible for typing-only classes.) We currently use an "attributes" table in the class docstring for this purpose; build on this by forcing MkDocs to render the respective class attribute too, via an empty "docstring" for the attribute. I considered enabling parameter headings, but these cannot be suppressed from the table of contents, and the table of contents then starts looking very cramped.
- Loading branch information
1 parent
1112627
commit 7dbdf93
Showing
3 changed files
with
30 additions
and
3 deletions.
There are no files selected for viewing
This file contains 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 file contains 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 file contains 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