diff --git a/autoapi/mappers/base.py b/autoapi/mappers/base.py index cfeefb3..9f711e0 100644 --- a/autoapi/mappers/base.py +++ b/autoapi/mappers/base.py @@ -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 diff --git a/autoapi/templates/index.rst b/autoapi/templates/index.rst index 0a80174..f8c78f0 100644 --- a/autoapi/templates/index.rst +++ b/autoapi/templates/index.rst @@ -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 `_