Fix code auto documentation

Fix linter errors
cobbler · Jun 14, 2024 · 639cc81 · 639cc81
1 parent 8f63980
commit 639cc81
Show file tree

Hide file tree

Showing 11 changed files with 26 additions and 4 deletions.
diff --git a/docs/code-autodoc/cobbler_tftp.exceptions.rst b/docs/code-autodoc/cobbler_tftp.exceptions.rst
@@ -1,3 +1,5 @@
+:no-index:
+
 cobbler\_tftp.exceptions package
 ================================
 

diff --git a/docs/code-autodoc/cobbler_tftp.rst b/docs/code-autodoc/cobbler_tftp.rst
@@ -1,3 +1,5 @@
+:no-index:
+
 cobbler\_tftp package
 =====================
 

diff --git a/docs/code-autodoc/cobbler_tftp.server.rst b/docs/code-autodoc/cobbler_tftp.server.rst
@@ -1,3 +1,5 @@
+:no-index:
+
 cobbler\_tftp.server package
 ============================
 

diff --git a/docs/code-autodoc/cobbler_tftp.settings.data.rst b/docs/code-autodoc/cobbler_tftp.settings.data.rst
@@ -1,3 +1,5 @@
+:no-index:
+
 cobbler\_tftp.settings.data package
 ===================================
 

diff --git a/docs/code-autodoc/cobbler_tftp.settings.migrations.rst b/docs/code-autodoc/cobbler_tftp.settings.migrations.rst
@@ -1,3 +1,5 @@
+:no-index:
+
 cobbler\_tftp.settings.migrations package
 =========================================
 

diff --git a/docs/code-autodoc/cobbler_tftp.settings.rst b/docs/code-autodoc/cobbler_tftp.settings.rst
@@ -1,3 +1,5 @@
+:no-index:
+
 cobbler\_tftp.settings package
 ==============================
 

diff --git a/docs/code-autodoc/cobbler_tftp.types.rst b/docs/code-autodoc/cobbler_tftp.types.rst
@@ -1,3 +1,5 @@
+:no-index:
+
 cobbler\_tftp.types package
 ===========================
 

diff --git a/docs/code-autodoc/modules.rst b/docs/code-autodoc/modules.rst
@@ -1,3 +1,5 @@
+:no-index:
+
 cobbler\_tftp
 =============
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -2,7 +2,6 @@
 #
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
-
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
@@ -18,6 +17,13 @@
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+source_suffix = ".rst"
+
+master_doc = "index"
+
+language = "en"
+
+pygments_style = "sphinx"
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -41,7 +41,7 @@ These **will override the configuration from your configuration file**.
 
 Cobbler-TFTP will automatically search for environment variables in this format:
 
-.. code-block:: bash
+.. code-block:: text
 
    COBBLER_TFTP__<PARENT_KEY>__<CHILD_KEY>__<...>__<KEY>=<VALUE>
 
@@ -65,7 +65,7 @@ parameters.
 
 These must be given in the format:
 
-.. code-block:: bash
+.. code-block:: text
 
    <PARENT_KEY>.<CHILD_KEY>.<..>.<KEY>=<VALUE>
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -12,7 +12,7 @@ Cobbler-TFTP is a stateless TFTP server for the dynamic creation of configuratio
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
-   
+
    Quickstart Guide <quickstart-guide>
    Installation <installation>
    Configuration <configuration>