Add jinja templates for apidoc (#3)

sphinx-apidoc now uses the *.rst.jinja name format

docs/source/_templates/apidoc/module.rst.jinja

@@ -0,0 +1,13 @@
+{%- if show_headings %}
+{{- basename.split(".")[-1] | e | heading }}
+{% endif -%}
+
+{%- set parts = basename.split('.') %}
+{%- set library_name = parts[0] %}
+{%- set module_name = parts[1] if parts | length > 1 else '' %}
+{%- set submodules = parts[2:] %}
+
+.. automodule:: {{ qualname }}
+{%- for option in automodule_options %}
+   :{{ option }}:
+{%- endfor %}

docs/source/_templates/apidoc/package.rst.jinja

@@ -0,0 +1,52 @@
+{%- macro automodule(modname, options) -%}
+.. automodule:: {{ modname }}
+{%- for option in options %}
+   :{{ option }}:
+{%- endfor %}
+{%- endmacro %}
+
+{%- macro toctree(docnames) -%}
+.. toctree::
+   :maxdepth: {{ maxdepth }}
+{% for docname in docnames %}
+   {{ docname }}
+{%- endfor %}
+{%- endmacro %}
+
+{%- if is_namespace %}
+{{- [pkgname, "namespace"] | join(" ") | e | heading }}
+{% else %}
+{{- pkgname.split(".")[-1] | e | heading }}
+{% endif %}
+
+{%- if is_namespace %}
+.. py:module:: {{ pkgname }}
+{% endif %}
+
+{%- if modulefirst and not is_namespace %}
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}
+
+{%- if subpackages %}
+
+{{ toctree(subpackages) }}
+{% endif %}
+
+{%- if submodules %}
+
+{% if separatemodules %}
+{{ toctree(submodules) }}
+{% else %}
+{%- for submodule in submodules %}
+{% if show_headings %}
+{{- submodule.split(".")[-1] | e | heading(2) }}
+{% endif %}
+{{ automodule(submodule, automodule_options) }}
+{% endfor %}
+{%- endif %}
+{%- endif %}
+
+{%- if not modulefirst and not is_namespace %}
+
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}

docs/source/_templates/apidoc/package.rst_t

@@ -39,21 +39,14 @@
 {% else %}
 {%- for submodule in submodules %}
 {% if show_headings %}
-
-{# Create breadcrumb navigation #}
-{%- set parts = submodule.split('.') -%}
-{%- for i in range(parts|length) %}
-{{ '[{}]({}.html)'.format(parts[i], '/'.join(parts[:i+1])) | e | heading(2) }}
-{%- endfor %}
-
-{%- endif %}
+{{- submodule.split(".")[-1] | e | heading(2) }}
+{% endif %}
+{{ automodule(submodule, automodule_options) }}
 {% endfor %}
 {%- endif %}
 {%- endif %}
 
 {%- if not modulefirst and not is_namespace %}
-Module contents
----------------
 
 {{ automodule(pkgname, automodule_options) }}
 {% endif %}

docs/source/conf.py

@@ -11,7 +11,7 @@
     "2024, Idiap Research Institute, https://www.idiap.ch, EPFL, https://www.epfl.ch"
 )
 author = "Roberto Boghetti"
-release = "0.1.2"
+release = "0.1.3"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration