From f774c852bcf7ca18e3d1f3868c7c0845fa76d389 Mon Sep 17 00:00:00 2001 From: ByteOtter Date: Tue, 28 May 2024 15:52:39 +0200 Subject: [PATCH] Fix missing documentation pages --- docs/code-autodoc/cobbler_tftp.rst | 46 +++++++++++++++++++++++ docs/code-autodoc/cobbler_tftp.server.rst | 21 +++++++++++ docs/code-autodoc/modules.rst | 43 ++++++++++++++++++++- docs/conf.py | 4 +- 4 files changed, 111 insertions(+), 3 deletions(-) create mode 100644 docs/code-autodoc/cobbler_tftp.server.rst diff --git a/docs/code-autodoc/cobbler_tftp.rst b/docs/code-autodoc/cobbler_tftp.rst index ccee212..11b46fe 100644 --- a/docs/code-autodoc/cobbler_tftp.rst +++ b/docs/code-autodoc/cobbler_tftp.rst @@ -11,6 +11,52 @@ Subpackages cobbler_tftp.settings cobbler_tftp.types +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cobbler_tftp.exceptions + cobbler_tftp.server + cobbler_tftp.settings + cobbler_tftp.types + +Submodules +---------- + +cobbler_tftp.exceptions +----------------------- + +.. automodule:: cobbler_tftp.exceptions + :members: + :undoc-members: + :show-inheritance: + +cobbler_tftp.server +------------------- + +.. automodule:: cobbler_tftp.server + :members: + :undoc-members: + :show-inheritance: + +cobbler_tftp.settings +--------------------- + +.. automodule:: cobbler_tftp.settings + :members: + :undoc-members: + :show-inheritance: + +cobbler_tftp.types +------------------ + +.. automodule:: cobbler_tftp.types + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/code-autodoc/cobbler_tftp.server.rst b/docs/code-autodoc/cobbler_tftp.server.rst new file mode 100644 index 0000000..aaac723 --- /dev/null +++ b/docs/code-autodoc/cobbler_tftp.server.rst @@ -0,0 +1,21 @@ +cobbler\_tftp.server package +============================ + +Submodules +---------- + +cobbler\_tftp.server.tftp module +-------------------------------- + +.. automodule:: cobbler_tftp.server.tftp + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cobbler_tftp.server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/code-autodoc/modules.rst b/docs/code-autodoc/modules.rst index 3b6bb47..04dd808 100644 --- a/docs/code-autodoc/modules.rst +++ b/docs/code-autodoc/modules.rst @@ -1,7 +1,48 @@ cobbler_tftp ============ +Subpackages +----------- + .. toctree:: :maxdepth: 4 - cobbler_tftp + cobbler_tftp.exceptions + cobbler_tftp.server + cobbler_tftp.settings + cobbler_tftp.types + +Submodules +---------- + +cobbler_tftp.exceptions +----------------------- + +.. automodule:: cobbler_tftp.exceptions + :members: + :undoc-members: + :show-inheritance: + +cobbler_tftp.server +------------------- + +.. automodule:: cobbler_tftp.server + :members: + :undoc-members: + :show-inheritance: + +cobbler_tftp.settings +--------------------- + +.. automodule:: cobbler_tftp.settings + :members: + :undoc-members: + :show-inheritance: + +cobbler_tftp.types +------------------ + +.. automodule:: cobbler_tftp.types + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py index 53d6f7b..5661423 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,8 +7,8 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "Cobbler-TFTP" -copyright = "2023, Christopher Hock" -author = "Christopher Hock" +copyright = "2023, The Cobbler Team" +author = "The Cobbler Team" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration