updating doc structure

docs/source/modules/modules.rst

@@ -1,7 +0,0 @@
-panaetius
-=========
-
-.. toctree::
-   :maxdepth: 4
-
-   panaetius

docs/source/modules/panaetius.config.rst

@@ -1,7 +1,7 @@
 .. include:: ../global.rst
 
 panaetius.config :modname:`panaetius.config`
--------------------------------------
+---------------------------------------------
 
 .. automodule:: panaetius.config
    :members:

docs/source/modules/panaetius.config_inst.rst

@@ -1,7 +1,7 @@
 .. include:: ../global.rst
 
 panaetius.config_inst :modname:`panaetius.config_inst`
----------------------------------------
+--------------------------------------------------------
 
 .. automodule:: panaetius.config_inst
    :members:

docs/source/modules/panaetius.header.rst

@@ -1,7 +1,7 @@
 .. include:: ../global.rst
 
 panaetius.header :modname:`panaetius.header`
--------------------------------------
+---------------------------------------------
 
 .. automodule:: panaetius.header
    :members:

docs/source/modules/panaetius.library.rst

@@ -1,7 +1,7 @@
 .. include:: ../global.rst
 
 panaetius.library :modname:`panaetius.library`
--------------------------------------
+------------------------------------------------
 
 .. automodule:: panaetius.library
    :members:

docs/source/modules/panaetius.rst

@@ -7,15 +7,3 @@ panaetius :modname:`panaetius`
    :members:
    :undoc-members:
    :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
-
-   panaetius.config
-   panaetius.config_inst
-   panaetius.db
-   panaetius.header
-   panaetius.library
-   panaetius.logging

docs/source/toc.rst

@@ -25,4 +25,3 @@
    modules/panaetius.header.rst
    modules/panaetius.library.rst
    modules/panaetius.logging.rst
-   modules/panaetius.rst

src/panaetius/db.py

@@ -39,6 +39,13 @@ class Mask:
 
     @property
     def hash(self):
+        """Property to determine the hash of a config entry.
+
+        Returns
+        -------
+        bytes
+            The hash as a bytes object.
+        """
         try:
             if not self._hash_exists:
                 pass
@@ -56,6 +63,13 @@ class Mask:
 
     @property
     def salt(self):
+        """Property to detemine a random salt to use in creation of the hash.
+
+        Returns
+        -------
+        bytes
+            The salt as a bytes object.
+        """
         self._salt = urandom(32)
         return self._salt