From 030405434d693f2c7fefafa0a869987e291283d7 Mon Sep 17 00:00:00 2001 From: dtomlinson Date: Mon, 13 Jan 2020 21:40:04 +0000 Subject: [PATCH] updating doc structure --- docs/source/modules/modules.rst | 7 ------- docs/source/modules/panaetius.config.rst | 2 +- docs/source/modules/panaetius.config_inst.rst | 2 +- docs/source/modules/panaetius.header.rst | 2 +- docs/source/modules/panaetius.library.rst | 2 +- docs/source/modules/panaetius.rst | 12 ------------ docs/source/toc.rst | 1 - src/panaetius/db.py | 14 ++++++++++++++ 8 files changed, 18 insertions(+), 24 deletions(-) delete mode 100644 docs/source/modules/modules.rst diff --git a/docs/source/modules/modules.rst b/docs/source/modules/modules.rst deleted file mode 100644 index 936cb1b..0000000 --- a/docs/source/modules/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -panaetius -========= - -.. toctree:: - :maxdepth: 4 - - panaetius diff --git a/docs/source/modules/panaetius.config.rst b/docs/source/modules/panaetius.config.rst index eca3252..285cc5d 100644 --- a/docs/source/modules/panaetius.config.rst +++ b/docs/source/modules/panaetius.config.rst @@ -1,7 +1,7 @@ .. include:: ../global.rst panaetius.config :modname:`panaetius.config` -------------------------------------- +--------------------------------------------- .. automodule:: panaetius.config :members: diff --git a/docs/source/modules/panaetius.config_inst.rst b/docs/source/modules/panaetius.config_inst.rst index 57a6bbc..984af9e 100644 --- a/docs/source/modules/panaetius.config_inst.rst +++ b/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: diff --git a/docs/source/modules/panaetius.header.rst b/docs/source/modules/panaetius.header.rst index 2ce60e5..f4bb770 100644 --- a/docs/source/modules/panaetius.header.rst +++ b/docs/source/modules/panaetius.header.rst @@ -1,7 +1,7 @@ .. include:: ../global.rst panaetius.header :modname:`panaetius.header` -------------------------------------- +--------------------------------------------- .. automodule:: panaetius.header :members: diff --git a/docs/source/modules/panaetius.library.rst b/docs/source/modules/panaetius.library.rst index 552dc86..7904df0 100644 --- a/docs/source/modules/panaetius.library.rst +++ b/docs/source/modules/panaetius.library.rst @@ -1,7 +1,7 @@ .. include:: ../global.rst panaetius.library :modname:`panaetius.library` -------------------------------------- +------------------------------------------------ .. automodule:: panaetius.library :members: diff --git a/docs/source/modules/panaetius.rst b/docs/source/modules/panaetius.rst index bd32b75..b9db600 100644 --- a/docs/source/modules/panaetius.rst +++ b/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 diff --git a/docs/source/toc.rst b/docs/source/toc.rst index a2ccebd..f6bea3e 100644 --- a/docs/source/toc.rst +++ b/docs/source/toc.rst @@ -25,4 +25,3 @@ modules/panaetius.header.rst modules/panaetius.library.rst modules/panaetius.logging.rst - modules/panaetius.rst diff --git a/src/panaetius/db.py b/src/panaetius/db.py index 82bbf60..e4846a7 100644 --- a/src/panaetius/db.py +++ b/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