docs: start documenting constants

Signed-off-by: William Roberts <william.c.roberts@intel.com>
tpm2-software · Dec 1, 2021 · ba2dd5c · ba2dd5c
1 parent 8a732fb
commit ba2dd5c
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/docs/constants.rst b/docs/constants.rst
@@ -0,0 +1,6 @@
+Constants
+=========
+
+.. automodule:: tpm2_pytss.constants
+   :members:
+   :undoc-members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -148,6 +148,7 @@ to change.
     :maxdepth: 2
     :caption: Contents:
 
+    constants
     types
     esys
     fapi

diff --git a/tpm2_pytss/constants.py b/tpm2_pytss/constants.py
@@ -1,5 +1,9 @@
 # SPDX-License-Identifier: BSD-2
+""" This module contains all the constant values from the TCG TSS specification
+- https://trustedcomputinggroup.org/resource/tss-overview-common-structures-specification
 
+Along with helpers to go from string values to constants and constant values to string values.
+"""
 from ._libtpm2_pytss import lib, ffi
 from tpm2_pytss.internal.utils import _CLASS_INT_ATTRS_from_string
 import pkgconfig