Merge pull request #12 from kas-lab/docs

Add documentation
kas-lab · Jan 10, 2024 · 289a099 · 289a099
2 parents 3a3dfda + 3fbf562
commit 289a099
Show file tree

Hide file tree

Showing 12 changed files with 887 additions and 307 deletions.
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -25,7 +25,7 @@ jobs:
           skip-tests: true
       - name: Install dependencies
         run: |
-          pip install sphinx sphinx_rtd_theme myst_parser sphinx-autopackagesummary typedb-driver
+          pip install sphinx sphinx_rtd_theme myst_parser sphinx-autopackagesummary sphinx-autodoc-typehints typedb-driver
       - name: Sphinx build
         run: |
           source ${{ steps.action_ros_ci_step.outputs.ros-workspace-directory-name }}/install/setup.bash && sphinx-build docs/source docs/build

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+docs/source/_autosummary/
+docs/source/generated/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rst
@@ -3,36 +3,28 @@
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
-
-   {% block methods %}
-
-   {% for item in methods %}
-   {%- if item not in inherited_members %}
-    .. automethod:: {{ item }}
-   {%- endif %}
-   {%- endfor %}
-
-   {% if methods %}
-   .. rubric:: {{ _('Methods') }}
-
-   .. autosummary::
-   {% for item in methods %}
-   {%- if item not in inherited_members %}
-      ~{{ name }}.{{ item }}
-   {%- endif %}
-   {%- endfor %}
-   {% endif %}
-   {% endblock %}
-
-   {% block attributes %}
-   {% if attributes %}
-   .. rubric:: {{ _('Attributes') }}
-
-   .. autosummary::
-   {% for item in attributes %}
-   {%- if item not in inherited_members %}
-      ~{{ name }}.{{ item }}
-   {%- endif %}
-   {%- endfor %}
-   {% endif %}
-   {% endblock %}
+  :members:
+  :undoc-members:
+  :special-members: __init__
+
+  {% if methods %}
+  .. rubric:: {{ _('Methods') }}
+
+  .. autosummary::
+  {% for item in methods %}
+  {%- if item not in inherited_members %}
+     ~{{ name }}.{{ item }}
+  {%- endif %}
+  {%- endfor %}
+  {% endif %}
+
+  {% if attributes %}
+  .. rubric:: {{ _('Attributes') }}
+
+  .. autosummary::
+  {% for item in attributes %}
+  {%- if item not in inherited_members %}
+     ~{{ name }}.{{ item }}
+  {%- endif %}
+  {%- endfor %}
+  {% endif %}
diff --git a/docs/source/_templates/autosummary/module.rst b/docs/source/_templates/autosummary/module.rst
@@ -0,0 +1,64 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1,8 +1,10 @@
 API
 =====
 
+
 .. autosummary::
-   :toctree: generated
+   :toctree: _autosummary
+   :recursive:
 
-   ros_typedb.typedb_interface.TypeDBInterface
-   ros_typedb.ros_typedb_interface.ROSTypeDBInterface
+   ros_typedb.typedb_interface
+   ros_typedb.ros_typedb_interface
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,7 +21,11 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
+    "sphinx_autodoc_typehints",
 ]
+autosummary_generate = True
+
+autoclass_content = 'both'
 
 intersphinx_mapping = {
     "rtd": ("https://docs.readthedocs.io/en/stable/", None),

diff --git a/docs/source/generated/ros_typedb.ros_typedb_interface.ROSTypeDBInterface.rst b/docs/source/generated/ros_typedb.ros_typedb_interface.ROSTypeDBInterface.rst
diff --git a/docs/source/generated/ros_typedb.typedb_interface.TypeDBInterface.rst b/docs/source/generated/ros_typedb.typedb_interface.TypeDBInterface.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -20,6 +20,7 @@ This package was tested in Ubuntu 22.04 with ROS Humble and typedb v2.24.17.
   installation
   usage
   api
+  :maxdepth: 1
 
 
 Contribute