Skip to content

Mkdocstrings doc updates #1434

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

Merged
merged 2 commits into from
Jan 22, 2024
+2 −1
Merged

Mkdocstrings doc updates #1434

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5de2f95
Restore Attribute symbol type in mkdocstrings template
waylan Jan 19, 2024
e46e2ee
Disable mkdocstrings show_symbol_type_toc option to work around searc…
waylan Jan 19, 2024
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 docs/templates/python/nature/attribute.html
View file
Original file line number Diff line number Diff line change
@@ -2,6 +2,7 @@

{% block heading scoped %}
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ attribute.filepath }}#L{{ attribute.lineno }}{% if attribute.endlineno > attribute.lineno %}-L{{ attribute.endlineno }}{% endif %}" title='View source code on GitHub'>&lsaquo;&rsaquo;</a>
{% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code>{% endif %}
{%+ filter highlight(language="python", inline=True) %}
{{ attribute_name }}{% if attribute.annotation %}: {{ attribute.annotation }}{% endif %}
{% endfilter %}
2 changes: 1 addition & 1 deletion mkdocs.yml
View file
Original file line number Diff line number Diff line change
@@ -104,7 +104,7 @@ plugins:
show_signature_annotations: true
show_source: false
show_symbol_type_heading: true
show_symbol_type_toc: true
show_symbol_type_toc: false
signature_crossrefs: false
summary: true
source: