Docs: Regenerated docs according to new feature

cobbler · Jun 14, 2023 · cbcd51e · cbcd51e
1 parent ad65a8b
commit cbcd51e
Show file tree

Hide file tree

Showing 12 changed files with 96 additions and 26 deletions.
diff --git a/docs/_static/extend_width.css b/docs/_static/extend_width.css
@@ -0,0 +1,3 @@
+.wy-nav-content {
+    max-width: 90% !important;
+}
diff --git a/docs/code-autodoc/cobbler_tftp.exceptions.rst b/docs/code-autodoc/cobbler_tftp.exceptions.rst
@@ -0,0 +1,21 @@
+cobbler\_tftp.exceptions package
+================================
+
+Submodules
+----------
+
+cobbler\_tftp.exceptions.settings\_exceptions module
+----------------------------------------------------
+
+.. automodule:: cobbler_tftp.exceptions.settings_exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cobbler_tftp.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/code-autodoc/cobbler_tftp.rst b/docs/code-autodoc/cobbler_tftp.rst
@@ -1,16 +1,15 @@
 cobbler\_tftp package
 =====================
 
-Submodules
-----------
+Subpackages
+-----------
 
-cobbler\_tftp.authentication module
------------------------------------
+.. toctree::
+   :maxdepth: 4
 
-.. automodule:: cobbler_tftp.authentication
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   cobbler_tftp.exceptions
+   cobbler_tftp.settings
+   cobbler_tftp.types
 
 Module contents
 ---------------

diff --git a/docs/code-autodoc/cobbler_tftp.settings.data.rst b/docs/code-autodoc/cobbler_tftp.settings.data.rst
@@ -0,0 +1,10 @@
+cobbler\_tftp.settings.data package
+===================================
+
+Module contents
+---------------
+
+.. automodule:: cobbler_tftp.settings.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/code-autodoc/cobbler_tftp.settings.migrations.rst b/docs/code-autodoc/cobbler_tftp.settings.migrations.rst
@@ -0,0 +1,21 @@
+cobbler\_tftp.settings.migrations package
+=========================================
+
+Submodules
+----------
+
+cobbler\_tftp.settings.migrations.v1\_0 module
+----------------------------------------------
+
+.. automodule:: cobbler_tftp.settings.migrations.v1_0
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cobbler_tftp.settings.migrations
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/code-autodoc/cobbler_tftp.settings.rst b/docs/code-autodoc/cobbler_tftp.settings.rst
@@ -0,0 +1,19 @@
+cobbler\_tftp.settings package
+==============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   cobbler_tftp.settings.data
+   cobbler_tftp.settings.migrations
+
+Module contents
+---------------
+
+.. automodule:: cobbler_tftp.settings
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/code-autodoc/cobbler_tftp.types.rst b/docs/code-autodoc/cobbler_tftp.types.rst
@@ -0,0 +1,10 @@
+cobbler\_tftp.types package
+===========================
+
+Module contents
+---------------
+
+.. automodule:: cobbler_tftp.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/code-autodoc/main.rst b/docs/code-autodoc/main.rst
diff --git a/docs/code-autodoc/modules.rst b/docs/code-autodoc/modules.rst
@@ -1,9 +1,7 @@
-src
-===
+cobbler_tftp
+============
 
 .. toctree::
    :maxdepth: 4
 
    cobbler_tftp
-   main
-   service
diff --git a/docs/code-autodoc/service.rst b/docs/code-autodoc/service.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -24,3 +24,4 @@
 
 html_theme = "sphinx_rtd_theme"
 html_static_path = ["_static"]
+html_css_files = ["extend_width.css"]
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,6 +10,8 @@ Welcome to Cobbler-TFTP's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   Code Documentation<code-autodoc/modules.rst>
+
 
 
 Indices and tables
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,3 +24,4 @@

		html_theme = "sphinx_rtd_theme"
		html_static_path = ["_static"]
		html_css_files = ["extend_width.css"]