Update doc to separate classes in api

2025-08-18 00:46:02 +00:00 · 2021-04-19 01:09:13 +02:00
parent 951f1cfaa7
commit 9eb06a9169
10 changed files with 55 additions and 17 deletions
--- a/docs/source/api/Siterator.rst
+++ b/docs/source/api/Siterator.rst
@@ -0,0 +1,9 @@
+Siterator
+=========
+
+.. automodule:: stree
+.. autoclass:: Siterator
+    :members:
+    :undoc-members:
+    :private-members:
+    :show-inheritance:
--- a/docs/source/api/Snode.rst
+++ b/docs/source/api/Snode.rst
@@ -0,0 +1,9 @@
+Snode
+=====
+
+.. automodule:: stree
+.. autoclass:: Snode
+    :members:
+    :undoc-members:
+    :private-members:
+    :show-inheritance:
--- a/docs/source/api/Splitter.rst
+++ b/docs/source/api/Splitter.rst
@@ -0,0 +1,9 @@
+Splitter
+========
+
+.. automodule:: stree
+.. autoclass:: Splitter
+    :members:
+    :undoc-members:
+    :private-members:
+    :show-inheritance:
--- a/docs/source/api/Stree.rst
+++ b/docs/source/api/Stree.rst
@@ -0,0 +1,9 @@
+Stree
+=====
+
+.. automodule:: stree
+.. autoclass:: Stree
+    :members:
+    :undoc-members:
+    :private-members:
+    :show-inheritance:
--- a/docs/source/api/index.rst
+++ b/docs/source/api/index.rst
@@ -0,0 +1,11 @@
+API index
+=========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   Stree
+   Splitter
+   Snode
+   Siterator