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

feat: add new show options for docstrings #56

Merged
merged 5 commits into from
Feb 3, 2023
Merged

feat: add new show options for docstrings #56

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b587eb5
feat: add new show options for docstrings
thatlittleboy Jan 29, 2023
bcdd772
rename options and remove show_function_title
thatlittleboy Feb 3, 2023
39b8fed
refactor: remove show_function_title
thatlittleboy Feb 3, 2023
2332a37
docs: rename options
thatlittleboy Feb 3, 2023
0c64cb7
refactor: resort options alphabetically
thatlittleboy Feb 3, 2023
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
62 changes: 61 additions & 1 deletion docs/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,68 @@
"type": "boolean",
"default": false
},
"show_docstring_description": {
"title": "Whether to display the textual block (including admonitions) in the object's docstring.",
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
"type": "boolean",
"default": true
},
"show_docstring_attributes": {
"title": "Whether to display the \"Attributes\" section in the object's docstring.",
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
"type": "boolean",
"default": true
},
"show_docstring_examples": {
"title": "Whether to display the \"Examples\" section in the object's docstring.",
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
"type": "boolean",
"default": true
},
"show_docstring_other_parameters": {
"title": "Whether to display the \"Other Parameters\" section in the object's docstring.",
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
"type": "boolean",
"default": true
},
"show_docstring_parameters": {
"title": "Whether to display the \"Parameters\" section in the object's docstring.",
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
"type": "boolean",
"default": true
},
"show_docstring_raises": {
"title": "Whether to display the \"Raises\" section in the object's docstring.",
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
"type": "boolean",
"default": true
},
"show_docstring_receives": {
"title": "Whether to display the \"Receives\" section in the object's docstring.",
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
"type": "boolean",
"default": true
},
"show_docstring_returns": {
"title": "Whether to display the \"Returns\" section in the object's docstring.",
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
"type": "boolean",
"default": true
},
"show_docstring_warns": {
"title": "Whether to display the \"Warns\" section in the object's docstring.",
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
"type": "boolean",
"default": true
},
"show_docstring_yields": {
"title": "Whether to display the \"Yields\" section in the object's docstring.",
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
"type": "boolean",
"default": true
},
"show_source": {
"title": "Show the source code of this object..",
"title": "Show the source code of this object.",
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
"type": "boolean",
"default": true
Expand Down
20 changes: 20 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 @@ -79,6 +79,16 @@ class PythonHandler(BaseHandler):
"separate_signature": False,
"line_length": 60,
"merge_init_into_class": False,
"show_docstring_description": True,
"show_docstring_attributes": True,
"show_docstring_examples": True,
"show_docstring_other_parameters": True,
"show_docstring_parameters": True,
"show_docstring_raises": True,
"show_docstring_receives": True,
"show_docstring_returns": True,
"show_docstring_warns": True,
"show_docstring_yields": True,
"show_source": True,
"show_bases": True,
"show_submodules": False,
Expand Down Expand Up @@ -119,6 +129,16 @@ class PythonHandler(BaseHandler):
line_length (int): Maximum line length when formatting code/signatures. Default: `60`.
merge_init_into_class (bool): Whether to merge the `__init__` method into the class' signature and docstring. Default: `False`.
show_if_no_docstring (bool): Show the object heading even if it has no docstring or children with docstrings. Default: `False`.
show_docstring_description (bool): Whether to display the textual block (including admonitions) in the object's docstring. Default: `True`.
show_docstring_section_attributes (bool): Whether to display the "Attributes" section in the object's docstring. Default: `True`.
show_docstring_section_examples (bool): Whether to display the "Examples" section in the object's docstring. Default: `True`.
show_docstring_section_other_parameters (bool): Whether to display the "Other Parameters" section in the object's docstring. Default: `True`.
show_docstring_section_parameters (bool): Whether to display the "Parameters" section in the object's docstring. Default: `True`.
show_docstring_section_raises (bool): Whether to display the "Raises" section in the object's docstring. Default: `True`.
show_docstring_section_receives (bool): Whether to display the "Receives" section in the object's docstring. Default: `True`.
show_docstring_section_returns (bool): Whether to display the "Returns" section in the object's docstring. Default: `True`.
show_docstring_section_warns (bool): Whether to display the "Warns" section in the object's docstring. Default: `True`.
show_docstring_section_yields (bool): Whether to display the "Yields" section in the object's docstring. Default: `True`.
pawamoy marked this conversation as resolved.
Show resolved Hide resolved

Attributes: Signatures/annotations options:
annotations_path (str): The verbosity for annotations path: `brief` (recommended), or `source` (as written in the source). Default: `"brief"`.
Expand Down
26 changes: 13 additions & 13 deletions src/mkdocstrings_handlers/python/templates/material/_base/docstring.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
{% if docstring_sections %}
{{ log.debug("Rendering docstring") }}
{% for section in docstring_sections %}
{% if section.kind.value == "text" %}
{% if config.show_docstring_description and section.kind.value == "text" %}
{{ section.value|convert_markdown(heading_level, html_id) }}
{% elif section.kind.value == "attributes" %}
{% elif config.show_docstring_attributes and section.kind.value == "attributes" %}
{% include "docstring/attributes.html" with context %}
{% elif section.kind.value == "parameters" %}
{% elif config.show_docstring_parameters and section.kind.value == "parameters" %}
{% include "docstring/parameters.html" with context %}
{% elif section.kind.value == "other parameters" %}
{% elif config.show_docstring_other_parameters and section.kind.value == "other parameters" %}
{% include "docstring/other_parameters.html" with context %}
{% elif section.kind.value == "raises" %}
{% elif config.show_docstring_raises and section.kind.value == "raises" %}
{% include "docstring/raises.html" with context %}
{% elif section.kind.value == "warns" %}
{% include "docstring/warns.html" with context %}
{% elif section.kind.value == "yields" %}
{% elif config.show_docstring_warns and section.kind.value == "warns" %}
{% include "docstring/warns.html" with context %}
{% elif config.show_docstring_yields and section.kind.value == "yields" %}
{% include "docstring/yields.html" with context %}
{% elif section.kind.value == "receives" %}
{% include "docstring/receives.html" with context %}
{% elif section.kind.value == "returns" %}
{% elif config.show_docstring_receives and section.kind.value == "receives" %}
{% include "docstring/receives.html" with context %}
{% elif config.show_docstring_returns and section.kind.value == "returns" %}
{% include "docstring/returns.html" with context %}
{% elif section.kind.value == "examples" %}
{% elif config.show_docstring_examples and section.kind.value == "examples" %}
{% include "docstring/examples.html" with context %}
{% elif section.kind.value == "admonition" %}
{% elif config.show_docstring_description and section.kind.value == "admonition" %}
{% include "docstring/admonition.html" with context %}
{% endif %}
{% endfor %}
Expand Down
72 changes: 37 additions & 35 deletions src/mkdocstrings_handlers/python/templates/material/_base/function.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,49 +13,51 @@
{% set show_full_path = config.show_object_full_path %}
{% endif %}

{% if not root or config.show_root_heading %}
{%- if config.show_function_title -%}
{% if not root or config.show_root_heading %}

{% filter heading(heading_level,
role="function",
id=html_id,
class="doc doc-heading",
toc_label=function.name ~ "()") %}
{% filter heading(heading_level,
role="function",
id=html_id,
class="doc doc-heading",
toc_label=function.name ~ "()") %}

pawamoy marked this conversation as resolved.
Show resolved Hide resolved
{% if config.separate_signature %}
<span class="doc doc-object-name doc-function-name">{% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}</span>
{% else %}
{% filter highlight(language="python", inline=True) %}
{% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
{% include "signature.html" with context %}
{% endfilter %}
{% endif %}
{% if config.separate_signature %}
<span class="doc doc-object-name doc-function-name">{% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}</span>
{% else %}
{% filter highlight(language="python", inline=True) %}
{% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
{% include "signature.html" with context %}
{% endfilter %}
{% endif %}

{% with labels = function.labels %}
{% include "labels.html" with context %}
{% endwith %}
{% with labels = function.labels %}
{% include "labels.html" with context %}
{% endwith %}

{% endfilter %}
{% endfilter %}

{% if config.separate_signature %}
{% filter highlight(language="python", inline=False) %}
{% filter format_signature(config.line_length) %}
{% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
{% include "signature.html" with context %}
{% if config.separate_signature %}
{% filter highlight(language="python", inline=False) %}
{% filter format_signature(config.line_length) %}
{% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
{% include "signature.html" with context %}
{% endfilter %}
{% endfilter %}
{% endfilter %}
{% endif %}
{% endif %}

{% else %}
{% if config.show_root_toc_entry %}
{% filter heading(heading_level,
role="function",
id=html_id,
toc_label=function.path if config.show_root_full_path else function.name,
hidden=True) %}
{% endfilter %}
{% else %}
{% if config.show_root_toc_entry %}
{% filter heading(heading_level,
role="function",
id=html_id,
toc_label=function.path if config.show_root_full_path else function.name,
hidden=True) %}
{% endfilter %}
{% endif %}
{% set heading_level = heading_level - 1 %}
{% endif %}
{% set heading_level = heading_level - 1 %}
{% endif %}
{%- endif -%}

<div class="doc doc-contents {% if root %}first{% endif %}">
{% with docstring_sections = function.docstring.parsed %}
Expand Down