added raw api docs and modified some lang

devanshshukla99 · May 3, 2023 · 2823a29 · 2823a29
1 parent b04b7cb
commit 2823a29
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 1 deletion.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,43 @@
+===================
+⚙API documentation
+===================
+
+main
+----
+
+.. automodule:: sphinx_versioned.__main__
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+----------
+
+sphinx extension
+----------------
+
+.. automodule:: sphinx_versioned.sphinx_
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+----------
+
+Versions container
+------------------
+
+.. automodule:: sphinx_versioned.versions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+----------
+
+Util
+----
+
+.. automodule:: sphinx_versioned.lib
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+----------
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,6 +19,7 @@ Project Links
     install
     tutorial
     themes
+    api
 
 .. toctree::
     :maxdepth: 1

diff --git a/docs/themes.rst b/docs/themes.rst
@@ -1,7 +1,7 @@
 .. _themes:
 
 ================
-Supported Themes
+Supported themes
 ================
 
 This project supports multiple themes such as: