mirror of
https://github.com/readthedocs/sphinx-autoapi
synced 2024-11-17 21:25:35 +00:00
Tidied up index page
This commit is contained in:
parent
8242f2ea13
commit
3b299be332
@ -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
|
||||
|
@ -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>`_
|
||||
|
Loading…
Reference in New Issue
Block a user