sphinx-autoapi/autoapi/templates/python/module.rst

{{ obj.name }}
{{ "=" * obj.name|length }}

.. py:module:: {{ obj.name }}

{%- if obj.docstring %}

.. autoapi-nested-parse::

   {{ obj.docstring|prepare_docstring|indent(3) }}

{% endif %}

{% block content %}
{%- for obj_item in obj.children %}

{{ obj_item.rendered|indent(0) }}

{%- endfor %}
{% endblock %}
Improvements to pydocstyle Python parsing * Moves relative path parsing away from the base mapper implementation * Change argument parsing from splitting first line of source with ',' to use AST traversal instead. This is not complete, but mostly PoC for now. Full traversal into argument type nodes will allow us to get nested dict() etc. We should open a ticket to track this work * Cleans up some of the templates to reduce duplicate titles * Adds a directive for nesting rST from constructs that might have headings. Remove the first heading in this case to address the case where a module has a docstring with a heading up front * Adds tests * Replaces example module with module that has more failing cases of parsing Closes #78 Fixes #80 Fixes #81 Fixes #82 Fixes #83 Fixes #84 Fixes #85 2016-11-02 23:29:28 +00:00			`{{ obj.name }}`
			`{{ "=" * obj.name\|length }}`

			`.. py:module:: {{ obj.name }}`
Clean up how we render templates. * Add top_level_object as global concept. * Fix toctree generation * Add passing of options to rendering 2015-06-10 20:13:34 +00:00
Add ability to configure options of display of objects. 2015-06-10 20:58:52 +00:00			`{%- if obj.docstring %}`
Updates for python stuff 2015-04-01 00:01:41 +00:00
Improvements to pydocstyle Python parsing * Moves relative path parsing away from the base mapper implementation * Change argument parsing from splitting first line of source with ',' to use AST traversal instead. This is not complete, but mostly PoC for now. Full traversal into argument type nodes will allow us to get nested dict() etc. We should open a ticket to track this work * Cleans up some of the templates to reduce duplicate titles * Adds a directive for nesting rST from constructs that might have headings. Remove the first heading in this case to address the case where a module has a docstring with a heading up front * Adds tests * Replaces example module with module that has more failing cases of parsing Closes #78 Fixes #80 Fixes #81 Fixes #82 Fixes #83 Fixes #84 Fixes #85 2016-11-02 23:29:28 +00:00			`.. autoapi-nested-parse::`
Fix templates to nest functions and use short names 2017-06-28 00:12:17 +00:00
Implement prepare_docstring filter that wraps Sphinx's This allows us to output docstrings in a reasonable fashion. 2016-11-04 22:17:50 +00:00			`{{ obj.docstring\|prepare_docstring\|indent(3) }}`
Updates for python stuff 2015-04-01 00:01:41 +00:00
			`{% endif %}`

Refactor into nicer top-level interface to the Domains. Languages refactored: * Python * JS 2015-06-06 23:11:49 +00:00			`{% block content %}`
Clean up how we render templates. * Add top_level_object as global concept. * Fix toctree generation * Add passing of options to rendering 2015-06-10 20:13:34 +00:00			`{%- for obj_item in obj.children %}`
Updates for python stuff 2015-04-01 00:01:41 +00:00
Add ability to configure options of display of objects. 2015-06-10 20:58:52 +00:00			`{{ obj_item.rendered\|indent(0) }}`
Sizable refactor of the autoapi tooling. Standard template context and rendering. Also refactor YAML loading for new YAML formats. 2015-04-23 20:31:03 +00:00
Fix Python support 2015-04-21 05:54:32 +00:00			`{%- endfor %}`
			`{% endblock %}`