From e71a7c4c828b10532e09ce9e7d1e208392b7bada Mon Sep 17 00:00:00 2001 From: Antoine van Gelder Date: Fri, 1 Mar 2024 17:03:56 +0200 Subject: [PATCH] docs: add api docs --- docs/source/api_docs/facedancer.backends.rst | 77 +++++++++++ .../api_docs/facedancer.classes.hid.rst | 37 ++++++ docs/source/api_docs/facedancer.classes.rst | 18 +++ docs/source/api_docs/facedancer.devices.rst | 37 ++++++ .../api_docs/facedancer.devices.umass.rst | 29 +++++ docs/source/api_docs/facedancer.filters.rst | 37 ++++++ docs/source/api_docs/facedancer.rst | 120 ++++++++++++++++++ docs/source/api_docs/modules.rst | 7 + 8 files changed, 362 insertions(+) create mode 100644 docs/source/api_docs/facedancer.backends.rst create mode 100644 docs/source/api_docs/facedancer.classes.hid.rst create mode 100644 docs/source/api_docs/facedancer.classes.rst create mode 100644 docs/source/api_docs/facedancer.devices.rst create mode 100644 docs/source/api_docs/facedancer.devices.umass.rst create mode 100644 docs/source/api_docs/facedancer.filters.rst create mode 100644 docs/source/api_docs/facedancer.rst create mode 100644 docs/source/api_docs/modules.rst diff --git a/docs/source/api_docs/facedancer.backends.rst b/docs/source/api_docs/facedancer.backends.rst new file mode 100644 index 00000000..5f41dffd --- /dev/null +++ b/docs/source/api_docs/facedancer.backends.rst @@ -0,0 +1,77 @@ +facedancer.backends package +=========================== + +Submodules +---------- + +facedancer.backends.MAXUSBApp module +------------------------------------ + +.. automodule:: facedancer.backends.MAXUSBApp + :members: + :undoc-members: + :show-inheritance: + +facedancer.backends.base module +------------------------------- + +.. automodule:: facedancer.backends.base + :members: + :undoc-members: + :show-inheritance: + +facedancer.backends.goodfet module +---------------------------------- + +.. automodule:: facedancer.backends.goodfet + :members: + :undoc-members: + :show-inheritance: + +facedancer.backends.greatdancer module +-------------------------------------- + +.. automodule:: facedancer.backends.greatdancer + :members: + :undoc-members: + :show-inheritance: + +facedancer.backends.greathost module +------------------------------------ + +.. automodule:: facedancer.backends.greathost + :members: + :undoc-members: + :show-inheritance: + +facedancer.backends.libusbhost module +------------------------------------- + +.. automodule:: facedancer.backends.libusbhost + :members: + :undoc-members: + :show-inheritance: + +facedancer.backends.moondancer module +------------------------------------- + +.. automodule:: facedancer.backends.moondancer + :members: + :undoc-members: + :show-inheritance: + +facedancer.backends.raspdancer module +------------------------------------- + +.. automodule:: facedancer.backends.raspdancer + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: facedancer.backends + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api_docs/facedancer.classes.hid.rst b/docs/source/api_docs/facedancer.classes.hid.rst new file mode 100644 index 00000000..bb466ca6 --- /dev/null +++ b/docs/source/api_docs/facedancer.classes.hid.rst @@ -0,0 +1,37 @@ +facedancer.classes.hid package +============================== + +Submodules +---------- + +facedancer.classes.hid.descriptor module +---------------------------------------- + +.. automodule:: facedancer.classes.hid.descriptor + :members: + :undoc-members: + :show-inheritance: + +facedancer.classes.hid.keyboard module +-------------------------------------- + +.. automodule:: facedancer.classes.hid.keyboard + :members: + :undoc-members: + :show-inheritance: + +facedancer.classes.hid.usage module +----------------------------------- + +.. automodule:: facedancer.classes.hid.usage + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: facedancer.classes.hid + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api_docs/facedancer.classes.rst b/docs/source/api_docs/facedancer.classes.rst new file mode 100644 index 00000000..318a79cb --- /dev/null +++ b/docs/source/api_docs/facedancer.classes.rst @@ -0,0 +1,18 @@ +facedancer.classes package +========================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + facedancer.classes.hid + +Module contents +--------------- + +.. automodule:: facedancer.classes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api_docs/facedancer.devices.rst b/docs/source/api_docs/facedancer.devices.rst new file mode 100644 index 00000000..234af6f1 --- /dev/null +++ b/docs/source/api_docs/facedancer.devices.rst @@ -0,0 +1,37 @@ +facedancer.devices package +========================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + facedancer.devices.umass + +Submodules +---------- + +facedancer.devices.ftdi module +------------------------------ + +.. automodule:: facedancer.devices.ftdi + :members: + :undoc-members: + :show-inheritance: + +facedancer.devices.keyboard module +---------------------------------- + +.. automodule:: facedancer.devices.keyboard + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: facedancer.devices + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api_docs/facedancer.devices.umass.rst b/docs/source/api_docs/facedancer.devices.umass.rst new file mode 100644 index 00000000..9b54d730 --- /dev/null +++ b/docs/source/api_docs/facedancer.devices.umass.rst @@ -0,0 +1,29 @@ +facedancer.devices.umass package +================================ + +Submodules +---------- + +facedancer.devices.umass.disk\_image module +------------------------------------------- + +.. automodule:: facedancer.devices.umass.disk_image + :members: + :undoc-members: + :show-inheritance: + +facedancer.devices.umass.umass module +------------------------------------- + +.. automodule:: facedancer.devices.umass.umass + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: facedancer.devices.umass + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api_docs/facedancer.filters.rst b/docs/source/api_docs/facedancer.filters.rst new file mode 100644 index 00000000..6ea22668 --- /dev/null +++ b/docs/source/api_docs/facedancer.filters.rst @@ -0,0 +1,37 @@ +facedancer.filters package +========================== + +Submodules +---------- + +facedancer.filters.base module +------------------------------ + +.. automodule:: facedancer.filters.base + :members: + :undoc-members: + :show-inheritance: + +facedancer.filters.logging module +--------------------------------- + +.. automodule:: facedancer.filters.logging + :members: + :undoc-members: + :show-inheritance: + +facedancer.filters.standard module +---------------------------------- + +.. automodule:: facedancer.filters.standard + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: facedancer.filters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api_docs/facedancer.rst b/docs/source/api_docs/facedancer.rst new file mode 100644 index 00000000..034bc1b2 --- /dev/null +++ b/docs/source/api_docs/facedancer.rst @@ -0,0 +1,120 @@ +facedancer package +================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + facedancer.backends + facedancer.classes + facedancer.devices + facedancer.filters + +Submodules +---------- + +facedancer.configuration module +------------------------------- + +.. automodule:: facedancer.configuration + :members: + :undoc-members: + :show-inheritance: + +facedancer.core module +---------------------- + +.. automodule:: facedancer.core + :members: + :undoc-members: + :show-inheritance: + +facedancer.descriptor module +---------------------------- + +.. automodule:: facedancer.descriptor + :members: + :undoc-members: + :show-inheritance: + +facedancer.device module +------------------------ + +.. automodule:: facedancer.device + :members: + :undoc-members: + :show-inheritance: + +facedancer.endpoint module +-------------------------- + +.. automodule:: facedancer.endpoint + :members: + :undoc-members: + :show-inheritance: + +facedancer.errors module +------------------------ + +.. automodule:: facedancer.errors + :members: + :undoc-members: + :show-inheritance: + +facedancer.interface module +--------------------------- + +.. automodule:: facedancer.interface + :members: + :undoc-members: + :show-inheritance: + +facedancer.logging module +------------------------- + +.. automodule:: facedancer.logging + :members: + :undoc-members: + :show-inheritance: + +facedancer.magic module +----------------------- + +.. automodule:: facedancer.magic + :members: + :undoc-members: + :show-inheritance: + +facedancer.proxy module +----------------------- + +.. automodule:: facedancer.proxy + :members: + :undoc-members: + :show-inheritance: + +facedancer.request module +------------------------- + +.. automodule:: facedancer.request + :members: + :undoc-members: + :show-inheritance: + +facedancer.types module +----------------------- + +.. automodule:: facedancer.types + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: facedancer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api_docs/modules.rst b/docs/source/api_docs/modules.rst new file mode 100644 index 00000000..dbbf5d62 --- /dev/null +++ b/docs/source/api_docs/modules.rst @@ -0,0 +1,7 @@ +facedancer +========== + +.. toctree:: + :maxdepth: 4 + + facedancer