From ba2dd5cb2a09d89b84f12da1309c80364ccf8ab9 Mon Sep 17 00:00:00 2001 From: William Roberts Date: Tue, 30 Nov 2021 14:30:35 -0600 Subject: [PATCH] docs: start documenting constants Signed-off-by: William Roberts --- docs/constants.rst | 6 ++++++ docs/index.rst | 1 + tpm2_pytss/constants.py | 4 ++++ 3 files changed, 11 insertions(+) create mode 100644 docs/constants.rst diff --git a/docs/constants.rst b/docs/constants.rst new file mode 100644 index 00000000..c546c3e1 --- /dev/null +++ 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 index 38e7dd68..380fff0f 100644 --- 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 index 79a177f2..037c75e2 100644 --- 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