-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🐛 📝 Fetch cookiecutter-cruft-poetry-tox-pre-commit-ci-cd#325
- Loading branch information
Showing
10 changed files
with
261 additions
and
1 deletion.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
API Reference | ||
============= | ||
|
||
.. toctree:: | ||
:titlesonly: | ||
|
||
{% for page in pages %} | ||
{% if page.top_level_object and page.display %} | ||
{{ page.include_path }} | ||
{% endif %} | ||
{% endfor %} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{% extends "python/data.rst" %} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
{% if obj.display %} | ||
.. py:{{ obj.type }}:: {{ obj.short_name }}{% if obj.args %}({{ obj.args }}){% endif %} | ||
{% for (args, return_annotation) in obj.overloads %} | ||
{{ " " * (obj.type | length) }} {{ obj.short_name }}{% if args %}({{ args }}){% endif %} | ||
{% endfor %} | ||
|
||
|
||
{% if obj.bases %} | ||
{% if "show-inheritance" in autoapi_options %} | ||
Bases: {% for base in obj.bases %}{{ base|link_objs }}{% if not loop.last %}, {% endif %}{% endfor %} | ||
{% endif %} | ||
|
||
|
||
{% if "show-inheritance-diagram" in autoapi_options and obj.bases != ["object"] %} | ||
.. autoapi-inheritance-diagram:: {{ obj.obj["full_name"] }} | ||
:parts: 1 | ||
{% if "private-members" in autoapi_options %} | ||
:private-bases: | ||
{% endif %} | ||
|
||
{% endif %} | ||
{% endif %} | ||
{% if obj.docstring %} | ||
{{ obj.docstring|indent(3) }} | ||
{% endif %} | ||
{% if "inherited-members" in autoapi_options %} | ||
{% set visible_classes = obj.classes|selectattr("display")|list %} | ||
{% else %} | ||
{% set visible_classes = obj.classes|rejectattr("inherited")|selectattr("display")|list %} | ||
{% endif %} | ||
{% for klass in visible_classes %} | ||
{{ klass.render()|indent(3) }} | ||
{% endfor %} | ||
{% if "inherited-members" in autoapi_options %} | ||
{% set visible_attributes = obj.attributes|selectattr("display")|list %} | ||
{% else %} | ||
{% set visible_attributes = obj.attributes|rejectattr("inherited")|selectattr("display")|list %} | ||
{% endif %} | ||
{% for attribute in visible_attributes %} | ||
{{ attribute.render()|indent(3) }} | ||
{% endfor %} | ||
{% if "inherited-members" in autoapi_options %} | ||
{% set visible_methods = obj.methods|selectattr("display")|list %} | ||
{% else %} | ||
{% set visible_methods = obj.methods|rejectattr("inherited")|selectattr("display")|list %} | ||
{% endif %} | ||
{% for method in visible_methods %} | ||
{{ method.render()|indent(3) }} | ||
{% endfor %} | ||
{% endif %} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
{% if obj.display %} | ||
.. py:{{ obj.type }}:: {{ obj.name }} | ||
{%+ if obj.value is not none or obj.annotation is not none -%} | ||
:annotation: | ||
{%- if obj.annotation %} :{{ obj.annotation }} | ||
{%- endif %} | ||
{%- if obj.value is not none %} = {% | ||
if obj.value is string and obj.value.splitlines()|count > 1 -%} | ||
Multiline-String | ||
|
||
.. raw:: html | ||
|
||
<details><summary>Show Value</summary> | ||
|
||
.. code-block:: text | ||
:linenos: | ||
{{ obj.value|indent(width=8) }} | ||
.. raw:: html | ||
|
||
</details> | ||
|
||
{%- else -%} | ||
{{ obj.value|string|truncate(100) }} | ||
{%- endif %} | ||
{%- endif %} | ||
{% endif %} | ||
|
||
|
||
{{ obj.docstring|indent(3) }} | ||
{% endif %} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{% extends "python/class.rst" %} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
{% if obj.display %} | ||
.. py:function:: {{ obj.short_name }}({{ obj.args }}){% if obj.return_annotation is not none %} -> {{ obj.return_annotation }}{% endif %} | ||
{% for (args, return_annotation) in obj.overloads %} | ||
{{ obj.short_name }}({{ args }}){% if return_annotation is not none %} -> {{ return_annotation }}{% endif %} | ||
|
||
{% endfor %} | ||
{% if sphinx_version >= (2, 1) %} | ||
{% for property in obj.properties %} | ||
:{{ property }}: | ||
{% endfor %} | ||
{% endif %} | ||
|
||
{% if obj.docstring %} | ||
{{ obj.docstring|indent(3) }} | ||
{% else %} | ||
{% endif %} | ||
{% endif %} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
{%- if obj.display %} | ||
{% if sphinx_version >= (2, 1) %} | ||
.. py:method:: {{ obj.short_name }}({{ obj.args }}){% if obj.return_annotation is not none %} -> {{ obj.return_annotation }}{% endif %} | ||
{% for (args, return_annotation) in obj.overloads %} | ||
{{ obj.short_name }}({{ args }}){% if return_annotation is not none %} -> {{ return_annotation }}{% endif %} | ||
|
||
{% endfor %} | ||
{% if obj.properties %} | ||
{% for property in obj.properties %} | ||
:{{ property }}: | ||
{% endfor %} | ||
|
||
{% else %} | ||
|
||
{% endif %} | ||
{% else %} | ||
.. py:{{ obj.method_type }}:: {{ obj.short_name }}({{ obj.args }}) | ||
{% for (args, return_annotation) in obj.overloads %} | ||
{{ " " * (obj.method_type | length) }} {{ obj.short_name }}({{ args }}) | ||
{% endfor %} | ||
|
||
{% endif %} | ||
{% if obj.docstring %} | ||
{{ obj.docstring|indent(3) }} | ||
{% endif %} | ||
{% endif %} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
{% if not obj.display %} | ||
:orphan: | ||
|
||
{% endif %} | ||
|
||
======================================================================================================= | ||
PLACEHOLDER THAT WILL BE EATEN BY SPHINX (note: purposely broken across two lines) | ||
see: https://stackoverflow.com/questions/27965192/python-sphinx-skips-first-section-when-generating-pdf | ||
|
||
:py:mod:`{{ obj.name }}` | ||
=========={{ "=" * obj.name|length }} | ||
|
||
.. py:module:: {{ obj.name }} | ||
{% if obj.docstring %} | ||
.. autoapi-nested-parse:: | ||
|
||
{{ obj.docstring|indent(3) }} | ||
|
||
{% endif %} | ||
|
||
{% block subpackages %} | ||
{% set visible_subpackages = obj.subpackages|selectattr("display")|list %} | ||
{% if visible_subpackages %} | ||
Subpackages | ||
----------- | ||
.. toctree:: | ||
:titlesonly: | ||
:maxdepth: 3 | ||
|
||
{% for subpackage in visible_subpackages %} | ||
{{ subpackage.short_name }}/index.rst | ||
{% endfor %} | ||
|
||
|
||
{% endif %} | ||
{% endblock %} | ||
{% block submodules %} | ||
{% set visible_submodules = obj.submodules|selectattr("display")|list %} | ||
{% if visible_submodules %} | ||
Submodules | ||
---------- | ||
.. toctree:: | ||
:titlesonly: | ||
:maxdepth: 1 | ||
|
||
{% for submodule in visible_submodules %} | ||
{{ submodule.short_name }}/index.rst | ||
{% endfor %} | ||
|
||
|
||
{% endif %} | ||
{% endblock %} | ||
{% block content %} | ||
{% if obj.all is not none %} | ||
{% set visible_children = obj.children|selectattr("short_name", "in", obj.all)|list %} | ||
{% elif obj.type is equalto("package") %} | ||
{% set visible_children = obj.children|selectattr("display")|list %} | ||
{% else %} | ||
{% set visible_children = obj.children|selectattr("display")|rejectattr("imported")|list %} | ||
{% endif %} | ||
{% if visible_children %} | ||
{{ obj.type|title }} Contents | ||
{{ "-" * obj.type|length }}--------- | ||
|
||
{% set visible_classes = visible_children|selectattr("type", "equalto", "class")|list %} | ||
{% set visible_functions = visible_children|selectattr("type", "equalto", "function")|list %} | ||
{% set visible_attributes = visible_children|selectattr("type", "equalto", "data")|list %} | ||
{% if "show-module-summary" in autoapi_options and (visible_classes or visible_functions) %} | ||
{% block classes scoped %} | ||
{% if visible_classes %} | ||
Classes | ||
~~~~~~~ | ||
|
||
.. autoapisummary:: | ||
|
||
{% for klass in visible_classes %} | ||
{{ klass.id }} | ||
{% endfor %} | ||
|
||
|
||
{% endif %} | ||
{% endblock %} | ||
|
||
{% block functions scoped %} | ||
{% if visible_functions %} | ||
Functions | ||
~~~~~~~~~ | ||
|
||
.. autoapisummary:: | ||
|
||
{% for function in visible_functions %} | ||
{{ function.id }} | ||
{% endfor %} | ||
|
||
|
||
{% endif %} | ||
{% endblock %} | ||
|
||
{% block attributes scoped %} | ||
{% if visible_attributes %} | ||
Attributes | ||
~~~~~~~~~~ | ||
|
||
.. autoapisummary:: | ||
|
||
{% for attribute in visible_attributes %} | ||
{{ attribute.id }} | ||
{% endfor %} | ||
|
||
|
||
{% endif %} | ||
{% endblock %} | ||
{% endif %} | ||
{% for obj_item in visible_children %} | ||
{{ obj_item.render()|indent(0) }} | ||
{% endfor %} | ||
{% endif %} | ||
{% endblock %} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{% extends "python/module.rst" %} |
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