mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
docs update (#2239)
* docs update * class template * no annotations in sig
This commit is contained in:
74
docs/_templates/python/material/_base/function.html
vendored
Normal file
74
docs/_templates/python/material/_base/function.html
vendored
Normal file
@@ -0,0 +1,74 @@
|
||||
{{ log.debug("Rendering " + function.path) }}
|
||||
|
||||
<div class="doc doc-object doc-function">
|
||||
{% with html_id = function.path %}
|
||||
|
||||
{% if root %}
|
||||
{% set show_full_path = config.show_root_full_path %}
|
||||
{% set root_members = True %}
|
||||
{% elif root_members %}
|
||||
{% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
|
||||
{% set root_members = False %}
|
||||
{% else %}
|
||||
{% set show_full_path = config.show_object_full_path %}
|
||||
{% endif %}
|
||||
|
||||
{% 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 ~ "()") %}
|
||||
|
||||
{% 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 %}
|
||||
|
||||
{% endfilter %}
|
||||
|
||||
{% if config.separate_signature %}
|
||||
{% filter highlight(language="python", inline=False) %}
|
||||
def {% filter format_signature(config.line_length) %}
|
||||
{% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
|
||||
{% include "signature.html" with context %}
|
||||
{% endfilter %}
|
||||
{% endfilter %}
|
||||
{% 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 %}
|
||||
{% endif %}
|
||||
{% set heading_level = heading_level - 1 %}
|
||||
{% endif %}
|
||||
|
||||
<div class="doc doc-contents {% if root %}first{% endif %}">
|
||||
{% with docstring_sections = function.docstring.parsed %}
|
||||
{% include "docstring.html" with context %}
|
||||
{% endwith %}
|
||||
|
||||
{% if config.show_source and function.source %}
|
||||
<details class="quote">
|
||||
<summary>Source code in <code>{{ function.relative_filepath }}</code></summary>
|
||||
{{ function.source|highlight(language="python", linestart=function.lineno, linenums=True) }}
|
||||
</details>
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
{% endwith %}
|
||||
</div>
|
||||
Reference in New Issue
Block a user