Skip to content
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.

Sign up for GitHub

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

Dotted path relative references #123

Closed
wants to merge 1 commit into from
Closed

Dotted path relative references #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ plugins:
inherited_members: true
merge_init_into_class: true
preload_modules: [mkdocstrings]
relative_crossrefs: true
separate_signature: true
show_root_heading: true
show_root_full_path: false
Expand Down
2 changes: 2 additions & 0 deletions src/mkdocstrings_handlers/python/handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ class PythonHandler(BaseHandler):
default_config: ClassVar[dict] = {
"docstring_style": "google",
"docstring_options": {},
"relative_crossrefs": True,
"show_symbol_type_heading": False,
"show_symbol_type_toc": False,
"show_root_heading": False,
Expand Down Expand Up @@ -158,6 +159,7 @@ class PythonHandler(BaseHandler):
docstring_options (dict): The options for the docstring parser. See parsers under [`griffe.docstrings`][].
docstring_section_style (str): The style used to render docstring sections. Options: `table`, `list`, `spacy`. Default: `"table"`.
merge_init_into_class (bool): Whether to merge the `__init__` method into the class' signature and docstring. Default: `False`.
relative_crossrefs (bool): Whether to expand `.`-prefixed references relative to the qualname and import path. Default: `True`.
show_if_no_docstring (bool): Show the object heading even if it has no docstring or children with docstrings. Default: `False`.
show_docstring_attributes (bool): Whether to display the "Attributes" section in the object's docstring. Default: `True`.
show_docstring_functions (bool): Whether to display the "Functions" or "Methods" sections in the object's docstring. Default: `True`.
Expand Down