Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adopt latest sphinx-autoapi templates #1183

Merged
merged 2 commits into from
Oct 29, 2024
Merged

adopt latest sphinx-autoapi templates #1183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2c348c
adopt latest sphinx-autoapi templates
bjlittle Oct 29, 2024
835d1b4
add changelog news fragment
bjlittle Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog/1183.documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Adopted `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`__
``3.3.3`` templates. (:user:`bjlittle`)
2 changes: 1 addition & 1 deletion docs/src/_autoapi_templates/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ℹ️
This directory contains templates copied from `sphinx-autoapi` 3.2.1, which have been customised for
This directory contains templates copied from `sphinx-autoapi` 3.3.3, which have been customised for
our own purposes.

For further details, see:
Expand Down
18 changes: 2 additions & 16 deletions docs/src/_autoapi_templates/python/module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,10 @@ GeoVista

{% endif %}

{% block subpackages %}
{% set visible_subpackages = obj.subpackages|selectattr("display")|list %}
{% if visible_subpackages %}
Subpackages
-----------

.. toctree::
:maxdepth: 1

{% for subpackage in visible_subpackages %}
{{ subpackage.include_path }}
{% endfor %}


{% endif %}
{% endblock %}
{% block submodules %}
{% set visible_subpackages = obj.subpackages|selectattr("display")|list %}
{% set visible_submodules = obj.submodules|selectattr("display")|list %}
{% set visible_submodules = (visible_subpackages + visible_submodules)|sort %}
{% if visible_submodules %}
Submodules
----------
Expand Down