docs: we shouldn't ignore "apidocs"

tanbro · Mar 17, 2024 · e122813 · e122813
1 parent 3df5a3a
commit e122813
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 1 deletion.
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/apidocs/jinjyaml.constructor.rst b/docs/apidocs/jinjyaml.constructor.rst
@@ -0,0 +1,7 @@
+jinjyaml.constructor module
+===========================
+
+.. automodule:: jinjyaml.constructor
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/apidocs/jinjyaml.data.rst b/docs/apidocs/jinjyaml.data.rst
@@ -0,0 +1,7 @@
+jinjyaml.data module
+====================
+
+.. automodule:: jinjyaml.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/apidocs/jinjyaml.functions.rst b/docs/apidocs/jinjyaml.functions.rst
@@ -0,0 +1,7 @@
+jinjyaml.functions module
+=========================
+
+.. automodule:: jinjyaml.functions
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/apidocs/jinjyaml.representer.rst b/docs/apidocs/jinjyaml.representer.rst
@@ -0,0 +1,7 @@
+jinjyaml.representer module
+===========================
+
+.. automodule:: jinjyaml.representer
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/apidocs/jinjyaml.rst b/docs/apidocs/jinjyaml.rst
@@ -0,0 +1,18 @@
+jinjyaml package
+================
+
+.. automodule:: jinjyaml
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   jinjyaml.constructor
+   jinjyaml.data
+   jinjyaml.functions
+   jinjyaml.representer