fix api docs

Author: antheas

docs/source/.gitignore

@@ -1 +1 @@
-packages
+api

docs/source/_templates/autosummary/base.rst

@@ -0,0 +1,5 @@
+{{ fullname | escape | underline}}
+
+    .. currentmodule:: {{ module }}
+
+    .. auto{{ objtype }}:: {{ objname }}

docs/source/_templates/autosummary/class.rst

@@ -0,0 +1,32 @@
+{{ fullname | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :undoc-members:
+   :inherited-members:
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Attributes
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block methods %}
+   {% if methods %}
+   .. rubric:: Methods
+
+   .. autosummary::
+   {% for item in all_methods %}
+      {%- if not item.startswith('_') %}
+      ~{{ name }}.{{ item }}
+      {%- endif -%}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

docs/source/_templates/autosummary/module.rst

@@ -0,0 +1,57 @@
+{{ fullname | escape | underline }}
+
+.. rubric:: Description
+
+.. automodule:: {{ fullname }}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: autosummary/class.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: Exceptions
+
+   .. autosummary::
+      :toctree:
+      :template: autosummary/class.rst
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :template: autosummary/module.rst
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

docs/source/conf.py

@@ -68,7 +68,7 @@
 # enable autosummary plugin (table of contents for modules/classes/class
 # methods)
 autosummary_generate = True
-autosummary_generate_overwrite = False
+autosummary_generate_overwrite = True
 napoleon_include_init_with_doc = True
 
 # Add any paths that contain templates here, relative to this directory.

docs/source/index.rst

@@ -20,7 +20,7 @@ API documentation
 =================
 
 .. autosummary::
-   :toctree: packages
+   :toctree: api
    :caption: API documentation
    :template: autosummary/module.rst
    :recursive:

src/pasteur/cli.py

@@ -1,3 +1,5 @@
+""" Provides the `cli` entrypoint for kedro. """
+
 # from .kedro.utils import get_pasteur_modules
 
 # if get_pasteur_modules():

src/pasteur/encode.py

@@ -24,8 +24,8 @@ class Encoder(ModuleClass):
     It is up to the encoder to filter it prior to processing. `data` should
     not be mutated."""
 
-    name: str
-    attr: Attribute
+    name: str = ""
+    attr: Attribute = Attribute("", {})
     _factory = EncoderFactory
 
     def fit(self, attr: Attribute, data: pd.DataFrame | None) -> Attribute:

src/pasteur/kedro/__init__.py

@@ -0,0 +1 @@
+""" This sub-package contains all kedro-related logic. """

src/pasteur/module.py

@@ -18,7 +18,7 @@ class Module:
     and there can be multiple visualizations for a certain column type.
     """
 
-    name: str
+    name: str = ""
 
 
 class ModuleClass: