update apidoc templates

mdtanker · Nov 19, 2023 · 8636362 · 8636362
1 parent 6cfd46c
commit 8636362
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 25 deletions.
diff --git a/docs/api/invert4geom.inversion.rst b/docs/api/invert4geom.inversion.rst
@@ -0,0 +1,6 @@
+invert4geom.inversion
+---------------------
+.. automodule:: invert4geom.inversion
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/invert4geom.rst b/docs/api/invert4geom.rst
@@ -0,0 +1,9 @@
+
+API Reference
+-------------
+
+.. toctree::
+   :maxdepth: 4
+
+   invert4geom.inversion
+   invert4geom.utils
diff --git a/docs/api/invert4geom.utils.rst b/docs/api/invert4geom.utils.rst
@@ -0,0 +1,6 @@
+invert4geom.utils
+-----------------
+.. automodule:: invert4geom.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/conf.py b/docs/conf.py
@@ -57,3 +57,7 @@
 ]
 
 always_document_param_types = True
+
+add_module_names = False
+
+add_function_parentheses = False
diff --git a/docs/template/module.rst_t b/docs/template/module.rst_t
@@ -1,5 +1,5 @@
 {%- if show_headings %}
-{{- [basename, "module"] | join(' ') | e | heading }}
+{{- basename | e | heading(2) }}
 {% endif -%}
 .. automodule:: {{ qualname }}
 {%- for option in automodule_options %}

diff --git a/docs/template/package.rst_t b/docs/template/package.rst_t
@@ -13,36 +13,15 @@
 {%- endfor %}
 {%- endmacro %}
 
-{%- if is_namespace %}
-{{- [pkgname, "namespace"] | join(" ") | e | heading }}
-{% else %}
-{{- [pkgname, "package"] | join(" ") | e | heading }}
-{% endif %}
-
-{%- if is_namespace %}
-.. py:module:: {{ pkgname }}
-{% endif %}
-
-{%- if modulefirst and not is_namespace %}
-{{ automodule(pkgname, automodule_options) }}
-{% endif %}
-
-{%- if subpackages %}
-Subpackages
------------
-
-{{ toctree(subpackages) }}
-{% endif %}
-
 {%- if submodules %}
-Submodules
-----------
+API Reference
+-------------
 {% if separatemodules %}
 {{ toctree(submodules) }}
 {% else %}
 {%- for submodule in submodules %}
 {% if show_headings %}
-{{- [submodule, "module"] | join(" ") | e | heading(2) }}
+{{- submodule | e | heading(2) }}
 {% endif %}
 {{ automodule(submodule, automodule_options) }}
 {% endfor %}