diff --git a/docs/conf.py b/docs/conf.py index 6fb6903..3732e61 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,13 +47,15 @@ def get_version(): # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - "sphinx.ext.autodoc", - "sphinx_autodoc_typehints", + "autoapi.extension", + "sphinx.ext.autodoc.typehints", "sphinx.ext.doctest", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", ] +autodoc_typehints = "description" + # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -191,3 +193,4 @@ def get_version(): # Custom config autodoc_member_order = "bysource" +autoapi_dirs = ["../fido2"] diff --git a/docs/index.rst b/docs/index.rst index c14c80b..59552ad 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,8 @@ Welcome to python-fido2's documentation! :maxdepth: 2 :caption: Contents: - rst/packages + autoapi/index + Indices and tables ================== diff --git a/docs/rst/fido2.attestation.rst b/docs/rst/fido2.attestation.rst deleted file mode 100644 index 1027362..0000000 --- a/docs/rst/fido2.attestation.rst +++ /dev/null @@ -1,61 +0,0 @@ -fido2.attestation package -========================= - -Submodules ----------- - -fido2.attestation.android module --------------------------------- - -.. automodule:: fido2.attestation.android - :members: - :undoc-members: - :show-inheritance: - -fido2.attestation.apple module ------------------------------- - -.. automodule:: fido2.attestation.apple - :members: - :undoc-members: - :show-inheritance: - -fido2.attestation.base module ------------------------------ - -.. automodule:: fido2.attestation.base - :members: - :undoc-members: - :show-inheritance: - -fido2.attestation.packed module -------------------------------- - -.. automodule:: fido2.attestation.packed - :members: - :undoc-members: - :show-inheritance: - -fido2.attestation.tpm module ----------------------------- - -.. automodule:: fido2.attestation.tpm - :members: - :undoc-members: - :show-inheritance: - -fido2.attestation.u2f module ----------------------------- - -.. automodule:: fido2.attestation.u2f - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: fido2.attestation - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/rst/fido2.ctap2.rst b/docs/rst/fido2.ctap2.rst deleted file mode 100644 index cabc827..0000000 --- a/docs/rst/fido2.ctap2.rst +++ /dev/null @@ -1,69 +0,0 @@ -fido2.ctap2 package -=================== - -Submodules ----------- - -fido2.ctap2.base module ------------------------ - -.. automodule:: fido2.ctap2.base - :members: - :undoc-members: - :show-inheritance: - -fido2.ctap2.bio module ----------------------- - -.. automodule:: fido2.ctap2.bio - :members: - :undoc-members: - :show-inheritance: - -fido2.ctap2.blob module ------------------------ - -.. automodule:: fido2.ctap2.blob - :members: - :undoc-members: - :show-inheritance: - -fido2.ctap2.config module -------------------------- - -.. automodule:: fido2.ctap2.config - :members: - :undoc-members: - :show-inheritance: - -fido2.ctap2.credman module --------------------------- - -.. automodule:: fido2.ctap2.credman - :members: - :undoc-members: - :show-inheritance: - -fido2.ctap2.extensions module ------------------------------ - -.. automodule:: fido2.ctap2.extensions - :members: - :undoc-members: - :show-inheritance: - -fido2.ctap2.pin module ----------------------- - -.. automodule:: fido2.ctap2.pin - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: fido2.ctap2 - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/rst/fido2.hid.rst b/docs/rst/fido2.hid.rst deleted file mode 100644 index b0d6839..0000000 --- a/docs/rst/fido2.hid.rst +++ /dev/null @@ -1,11 +0,0 @@ -fido2.hid package -================= - - -Module contents ---------------- - -.. automodule:: fido2.hid - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/rst/fido2.rst b/docs/rst/fido2.rst deleted file mode 100644 index d560c6b..0000000 --- a/docs/rst/fido2.rst +++ /dev/null @@ -1,120 +0,0 @@ -fido2 package -============= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - fido2.attestation - fido2.ctap2 - fido2.hid - -Submodules ----------- - -fido2.cbor module ------------------ - -.. automodule:: fido2.cbor - :members: - :undoc-members: - :show-inheritance: - -fido2.client module -------------------- - -.. automodule:: fido2.client - :members: - :undoc-members: - :show-inheritance: - -fido2.cose module ------------------ - -.. automodule:: fido2.cose - :members: - :undoc-members: - :show-inheritance: - -fido2.ctap module ------------------ - -.. automodule:: fido2.ctap - :members: - :undoc-members: - :show-inheritance: - -fido2.ctap1 module ------------------- - -.. automodule:: fido2.ctap1 - :members: - :undoc-members: - :show-inheritance: - -fido2.features module ---------------------- - -.. automodule:: fido2.features - :members: - :undoc-members: - :show-inheritance: - -fido2.mds3 module ------------------ - -.. automodule:: fido2.mds3 - :members: - :undoc-members: - :show-inheritance: - -fido2.pcsc module ------------------ - -.. automodule:: fido2.pcsc - :members: - :undoc-members: - :show-inheritance: - -fido2.rpid module ------------------ - -.. automodule:: fido2.rpid - :members: - :undoc-members: - :show-inheritance: - -fido2.server module -------------------- - -.. automodule:: fido2.server - :members: - :undoc-members: - :show-inheritance: - -fido2.utils module ------------------- - -.. automodule:: fido2.utils - :members: - :undoc-members: - :show-inheritance: - -fido2.webauthn module ---------------------- - -.. automodule:: fido2.webauthn - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: fido2 - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/rst/packages.rst b/docs/rst/packages.rst deleted file mode 100644 index 3fe3549..0000000 --- a/docs/rst/packages.rst +++ /dev/null @@ -1,7 +0,0 @@ -python-fido2 -============ - -.. toctree:: - :maxdepth: 4 - - fido2 diff --git a/pyproject.toml b/pyproject.toml index d9700c3..5bde8c8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -42,7 +42,7 @@ pcsc = ["pyscard"] pytest = "^7.0" Sphinx = {version = "^8.1", python = ">=3.10"} sphinx-rtd-theme = {version = "^3.0.1", python = ">=3.10"} -sphinx-autodoc-typehints = {version = "^2.5.0", python = ">=3.10"} +sphinx-autoapi = (version = "^3.3.3", python = ">=3.10"} [build-system] requires = ["poetry-core>=1.0.0"]