Skip to content

Commit

Permalink
Fix missing documentation pages
Browse files Browse the repository at this point in the history
  • Loading branch information
ByteOtter committed May 28, 2024
1 parent 306fe8d commit f774c85
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 3 deletions.
46 changes: 46 additions & 0 deletions docs/code-autodoc/cobbler_tftp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------

Expand Down
21 changes: 21 additions & 0 deletions docs/code-autodoc/cobbler_tftp.server.rst
Original file line number Diff line number Diff line change
@@ -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:
43 changes: 42 additions & 1 deletion docs/code-autodoc/modules.rst
Original file line number Diff line number Diff line change
@@ -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:
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit f774c85

Please sign in to comment.