Tidied up index page

This commit is contained in:
Ashley Whetter 2019-04-06 10:33:38 -07:00
parent 8242f2ea13
commit 3b299be332
2 changed files with 18 additions and 13 deletions

View File

@ -140,6 +140,14 @@ class PythonMapperBase(object):
parts.append("index")
return "/".join(parts)
@property
def display(self):
"""Whether to display this object or not.
:type: bool
"""
return True
@property
def ref_type(self):
return self.type

View File

@ -1,18 +1,15 @@
Sphinx AutoAPI Index
####################
API Reference
=============
This page is the top-level of your generated API documentation.
Below is a list of all items that are documented here.
This page contains auto-generated API reference documentation [#f1]_.
.. toctree::
:includehidden:
:glob:
:maxdepth: 1
:titlesonly:
{# Force whitespace #}
{%- for page in pages %}
{%- if page.top_level_object %}
{% for page in pages %}
{% if page.top_level_object and page.display %}
{{ page.include_path }}
{%- endif %}
{%- endfor %}
{% endif %}
{% endfor %}
.. [#f1] Created with `sphinx-autoapi <https://github.com/rtfd/sphinx-autoapi>`_