regenerate docs with 'sphinx-apidoc fastkml -o docs'

cleder · Oct 26, 2024 · bf1b262 · bf1b262
1 parent 0cd9018
commit bf1b262
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 7 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,7 +32,9 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
     "sphinx.ext.napoleon",
+    "sphinx.ext.autosummary",
 ]
+autosummary_generate = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/docs/fastkml.rst b/docs/fastkml.rst
@@ -1,13 +1,7 @@
 fastkml package
 ===============
 
-Module contents
----------------
-
 .. automodule:: fastkml
-   :members:
-   :undoc-members:
-   :no-index:
 
 
 Submodules
@@ -45,6 +39,14 @@ fastkml.config module
    :undoc-members:
    :show-inheritance:
 
+fastkml.containers module
+-------------------------
+
+.. automodule:: fastkml.containers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 fastkml.data module
 -------------------
 
@@ -69,6 +71,14 @@ fastkml.exceptions module
    :undoc-members:
    :show-inheritance:
 
+fastkml.features module
+-----------------------
+
+.. automodule:: fastkml.features
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 fastkml.geometry module
 -----------------------
 
@@ -100,7 +110,22 @@ fastkml.kml module
    :members:
    :undoc-members:
    :show-inheritance:
-   :no-index: StyleUrl
+
+fastkml.kml\_base module
+------------------------
+
+.. automodule:: fastkml.kml_base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+fastkml.links module
+--------------------
+
+.. automodule:: fastkml.links
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 fastkml.mixins module
 ---------------------
@@ -110,6 +135,22 @@ fastkml.mixins module
    :undoc-members:
    :show-inheritance:
 
+fastkml.overlays module
+-----------------------
+
+.. automodule:: fastkml.overlays
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+fastkml.registry module
+-----------------------
+
+.. automodule:: fastkml.registry
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 fastkml.styles module
 ---------------------
 
@@ -134,6 +175,14 @@ fastkml.types module
    :undoc-members:
    :show-inheritance:
 
+fastkml.utils module
+--------------------
+
+.. automodule:: fastkml.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 fastkml.views module
 --------------------
 

diff --git a/fastkml/utils.py b/fastkml/utils.py
@@ -7,6 +7,8 @@
 from typing import Type
 from typing import Union
 
+__all__ = ["find_all", "has_attribute_values"]
+
 
 def has_attribute_values(obj: object, **kwargs: Any) -> bool:
     """