This commit is contained in:
jonesmarvin8
2026-04-26 20:27:22 -04:00
parent a99fccd704
commit 41f34f4ff4
138 changed files with 7538 additions and 125 deletions
+36
View File
@@ -0,0 +1,36 @@
import os
import sys
sys.path.insert(0, os.path.abspath('../../'))
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'KeyCard.py'
copyright = '2025, mmlado'
author = 'mmlado'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx.ext.autodoc',
'sphinx_autodoc_typehints',
'sphinx.ext.napoleon', # Google/NumPy style docstrings
]
templates_path = ['_templates']
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'alabaster'
html_static_path = ['_static']
+21
View File
@@ -0,0 +1,21 @@
.. KeyCard.py documentation master file, created by
sphinx-quickstart on Thu Jun 26 13:32:43 2025.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
KeyCard.py documentation
========================
Add your content using ``reStructuredText`` syntax. See the
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
documentation for details.
.. toctree::
:maxdepth: 2
:caption: Contents:
modules
.. automodule:: keycard.keycard
:members:
@@ -0,0 +1,77 @@
keycard.commands package
========================
Submodules
----------
keycard.commands.ident module
-----------------------------
.. automodule:: keycard.commands.ident
:members:
:undoc-members:
:show-inheritance:
keycard.commands.init module
-----------------------------
.. automodule:: keycard.commands.init
:members:
:undoc-members:
:show-inheritance:
keycard.commands.mutually_authenticate module
-----------------------------
.. automodule:: keycard.commands.mutually_authenticate
:members:
:undoc-members:
:show-inheritance:
keycard.commands.open_secure_channel module
-----------------------------
.. automodule:: keycard.commands.open_secure_channel
:members:
:undoc-members:
:show-inheritance:
keycard.commands.pair module
-----------------------------
.. automodule:: keycard.commands.pair
:members:
:undoc-members:
:show-inheritance:
keycard.commands.select module
-----------------------------
.. automodule:: keycard.commands.select
:members:
:undoc-members:
:show-inheritance:
keycard.commands.unpair module
-----------------------------
.. automodule:: keycard.commands.unpair
:members:
:undoc-members:
:show-inheritance:
keycard.commands.verify_pin module
-----------------------------
.. automodule:: keycard.commands.verify_pin
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: keycard.commands
:members:
:show-inheritance:
:undoc-members:
+29
View File
@@ -0,0 +1,29 @@
keycard.crypto package
======================
Submodules
----------
keycard.crypto.aes module
-------------------------
.. automodule:: keycard.crypto.aes
:members:
:show-inheritance:
:undoc-members:
keycard.crypto.padding module
-----------------------------
.. automodule:: keycard.crypto.padding
:members:
:show-inheritance:
:undoc-members:
Module contents
---------------
.. automodule:: keycard.crypto
:members:
:show-inheritance:
:undoc-members:
@@ -0,0 +1,45 @@
keycard.parsing package
=======================
Submodules
----------
keycard.parsing.application\_info module
----------------------------------------
.. automodule:: keycard.parsing.application_info
:members:
:show-inheritance:
:undoc-members:
keycard.parsing.capabilities module
-----------------------------------
.. automodule:: keycard.parsing.capabilities
:members:
:show-inheritance:
:undoc-members:
keycard.parsing.identity module
-------------------------------
.. automodule:: keycard.parsing.identity
:members:
:show-inheritance:
:undoc-members:
keycard.parsing.tlv module
--------------------------
.. automodule:: keycard.parsing.tlv
:members:
:show-inheritance:
:undoc-members:
Module contents
---------------
.. automodule:: keycard.parsing
:members:
:show-inheritance:
:undoc-members:
+63
View File
@@ -0,0 +1,63 @@
keycard package
===============
Subpackages
-----------
.. toctree::
:maxdepth: 4
keycard.commands
keycard.crypto
keycard.parsing
Submodules
----------
keycard.apdu module
-------------------
.. automodule:: keycard.apdu
:members:
:show-inheritance:
:undoc-members:
keycard.constants module
------------------------
.. automodule:: keycard.constants
:members:
:show-inheritance:
:undoc-members:
keycard.exceptions module
-------------------------
.. automodule:: keycard.exceptions
:members:
:show-inheritance:
:undoc-members:
keycard.keycard module
----------------------
.. automodule:: keycard.keycard
:members:
:show-inheritance:
:undoc-members:
keycard.transport module
------------------------
.. automodule:: keycard.transport
:members:
:show-inheritance:
:undoc-members:
Module contents
---------------
.. automodule:: keycard
:members:
:show-inheritance:
:undoc-members:
+7
View File
@@ -0,0 +1,7 @@
keycard
=======
.. toctree::
:maxdepth: 4
keycard