Expand autosummary templates, config

Author: khaeru

doc/_template/autosummary/class.rst

@@ -0,0 +1,34 @@
+.. From https://stackoverflow.com/a/62613202/2362198
+
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% for item in methods %}
+      ~{{ name}}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name}}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

doc/_template/autosummary/module.rst

@@ -1,6 +1,6 @@
 .. From https://stackoverflow.com/a/62613202/2362198
 
-.. {{ (":mod:`." + fullname.split(".", maxsplit=1)[1] + "` " + objtype) | underline(line="*") }}
+.. {{ (":mod:`." + fullname.split(".", maxsplit=1)[1] + "` " + objtype) }}
 
 Code reference
 ==============
@@ -59,13 +59,11 @@ Code reference
    .. rubric:: {{ _('Classes') }}
 
    .. autosummary::
+      :toctree:
+      :template: autosummary/class.rst
    {% for item in classes %}
       {{ item }}
    {%- endfor %}
-
-   {% for item in classes %}
-   .. autoclass:: {{ item }}
-   {%- endfor %}
    {% endif %}
    {% endblock %}
 

doc/conf.py

@@ -7,6 +7,8 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+import transport_data  # noqa: F401
+
 if TYPE_CHECKING:
     import sphinx.application
 
@@ -54,6 +56,10 @@ def setup(app: "sphinx.application.Sphinx"):
 
 html_css_files = ["css/custom.css"]
 
+# -- Options for sphinx.ext.autosummary ------------------------------------------------
+
+autosummary_generate = True
+
 # -- Options for sphinx.ext.extlinks ---------------------------------------------------
 
 extlinks = {
@@ -67,6 +73,7 @@ def setup(app: "sphinx.application.Sphinx"):
 intersphinx_mapping = {
     "click": ("https://click.palletsprojects.com/en/8.1.x/", None),
     "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
+    "platformdirs": ("https://platformdirs.readthedocs.io/en/latest/", None),
     "pooch": ("https://www.fatiando.org/pooch/latest/", None),
     "py": ("https://docs.python.org/3/", None),
     "pytest": ("https://docs.pytest.org/en/stable/", None),
@@ -93,7 +100,10 @@ def linkcode_resolve(domain, info):
     rel = Path(module.__file__).relative_to(base_path[info["module"].split(".")[0]])
 
     # The object itself
-    obj = getattr(module, info["fullname"])
+    try:
+        obj = getattr(module, info["fullname"])
+    except AttributeError:
+        return None
     try:
         # First line number
         firstlineno = obj.__code__.co_firstlineno
@@ -103,3 +113,8 @@ def linkcode_resolve(domain, info):
         fragment = f"#L{firstlineno}"  # Function, class, or other definition
 
     return f"{base_url}{rel}{fragment}"
+
+
+# -- Options for sphinx.ext.napoleon ---------------------------------------------------
+
+napoleon_preprocess_types = True