From 639cc8118c1ad9b1e9bc10fa2e738265cea792eb Mon Sep 17 00:00:00 2001 From: ByteOtter Date: Fri, 14 Jun 2024 14:01:55 +0200 Subject: [PATCH] Fix code auto documentation Fix linter errors --- docs/code-autodoc/cobbler_tftp.exceptions.rst | 2 ++ docs/code-autodoc/cobbler_tftp.rst | 2 ++ docs/code-autodoc/cobbler_tftp.server.rst | 2 ++ docs/code-autodoc/cobbler_tftp.settings.data.rst | 2 ++ docs/code-autodoc/cobbler_tftp.settings.migrations.rst | 2 ++ docs/code-autodoc/cobbler_tftp.settings.rst | 2 ++ docs/code-autodoc/cobbler_tftp.types.rst | 2 ++ docs/code-autodoc/modules.rst | 2 ++ docs/conf.py | 8 +++++++- docs/configuration.rst | 4 ++-- docs/index.rst | 2 +- 11 files changed, 26 insertions(+), 4 deletions(-) diff --git a/docs/code-autodoc/cobbler_tftp.exceptions.rst b/docs/code-autodoc/cobbler_tftp.exceptions.rst index f69deee..dcd7f89 100644 --- 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 index 11b46fe..177e4ac 100644 --- 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 index aaac723..98b7815 100644 --- 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 index 6569389..b7500fe 100644 --- 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 index 6a97620..969b8f4 100644 --- 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 index 91fef1c..66379e7 100644 --- 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 index a77eb41..6ffb068 100644 --- 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 index 7150f28..afb99cb 100644 --- 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 index 5661423..ba35977 100644 --- 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 index abdf03f..9fd4c28 100644 --- 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______<...>__= @@ -65,7 +65,7 @@ parameters. These must be given in the format: -.. code-block:: bash +.. code-block:: text ..<..>.= diff --git a/docs/index.rst b/docs/index.rst index 169667d..01e6cf5 100644 --- 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 Installation Configuration