Add full API documentation (#7614)

A lot of Certbot's files don't have API documentation which is fixed by this PR. To do this, from the top level certbot directory I ran: ``` sphinx-apidoc -Me -o docs/api certbot ``` I then merged the resulting `modules.rst` file with `docs/api.rst`.
2026-07-28 08:44:24 +02:00 · 2019-12-03 09:54:37 -08:00
parent 27d6f62a96
commit 3cfa63483d
41 changed files with 258 additions and 79 deletions
@@ -3,6 +3,6 @@ API Documentation
 =================

 .. toctree::
-   :glob:
+   :maxdepth: 4

-   api/**
+   api/certbot
@@ -1,5 +0,0 @@
-:mod:`certbot.achallenges`
------------------------------
-
-.. automodule:: certbot.achallenges
-   :members:
@@ -0,0 +1,7 @@
+certbot.achallenges module
+==========================
+
+.. automodule:: certbot.achallenges
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.compat.filesystem module
+================================
+
+.. automodule:: certbot.compat.filesystem
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.compat.misc module
+==========================
+
+.. automodule:: certbot.compat.misc
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.compat.os module
+========================
+
+.. automodule:: certbot.compat.os
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,17 @@
+certbot.compat package
+======================
+
+.. automodule:: certbot.compat
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   certbot.compat.filesystem
+   certbot.compat.misc
+   certbot.compat.os
+
@@ -0,0 +1,7 @@
+certbot.crypto\_util module
+===========================
+
+.. automodule:: certbot.crypto_util
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.display.ops module
+==========================
+
+.. automodule:: certbot.display.ops
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,16 @@
+certbot.display package
+=======================
+
+.. automodule:: certbot.display
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   certbot.display.ops
+   certbot.display.util
+
@@ -0,0 +1,7 @@
+certbot.display.util module
+===========================
+
+.. automodule:: certbot.display.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.errors module
+=====================
+
+.. automodule:: certbot.errors
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.interfaces module
+=========================
+
+.. automodule:: certbot.interfaces
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.main module
+===================
+
+.. automodule:: certbot.main
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.plugins.common module
+=============================
+
+.. automodule:: certbot.plugins.common
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.plugins.dns\_common module
+==================================
+
+.. automodule:: certbot.plugins.dns_common
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.plugins.dns\_common\_lexicon module
+===========================================
+
+.. automodule:: certbot.plugins.dns_common_lexicon
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.plugins.dns\_test\_common module
+========================================
+
+.. automodule:: certbot.plugins.dns_test_common
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.plugins.dns\_test\_common\_lexicon module
+=================================================
+
+.. automodule:: certbot.plugins.dns_test_common_lexicon
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.plugins.enhancements module
+===================================
+
+.. automodule:: certbot.plugins.enhancements
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,22 @@
+certbot.plugins package
+=======================
+
+.. automodule:: certbot.plugins
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   certbot.plugins.common
+   certbot.plugins.dns_common
+   certbot.plugins.dns_common_lexicon
+   certbot.plugins.dns_test_common
+   certbot.plugins.dns_test_common_lexicon
+   certbot.plugins.enhancements
+   certbot.plugins.storage
+   certbot.plugins.util
+
@@ -0,0 +1,7 @@
+certbot.plugins.storage module
+==============================
+
+.. automodule:: certbot.plugins.storage
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.plugins.util module
+===========================
+
+.. automodule:: certbot.plugins.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.reverter module
+=======================
+
+.. automodule:: certbot.reverter
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,31 @@
+certbot package
+===============
+
+.. automodule:: certbot
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    certbot.compat
+    certbot.display
+    certbot.plugins
+    certbot.tests
+
+Submodules
+----------
+
+.. toctree::
+
+   certbot.achallenges
+   certbot.crypto_util
+   certbot.errors
+   certbot.interfaces
+   certbot.main
+   certbot.reverter
+   certbot.util
+
@@ -0,0 +1,7 @@
+certbot.tests.acme\_util module
+===============================
+
+.. automodule:: certbot.tests.acme_util
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,16 @@
+certbot.tests package
+=====================
+
+.. automodule:: certbot.tests
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   certbot.tests.acme_util
+   certbot.tests.util
+
@@ -0,0 +1,7 @@
+certbot.tests.util module
+=========================
+
+.. automodule:: certbot.tests.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+certbot.util module
+===================
+
+.. automodule:: certbot.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -1,5 +0,0 @@
-:mod:`certbot.crypto_util`
------------------------------
-
-.. automodule:: certbot.crypto_util
-   :members:
@@ -1,17 +0,0 @@
-:mod:`certbot.display`
--------------------------
-
-.. automodule:: certbot.display
-   :members:
-
-:mod:`certbot.display.util`
-===============================
-
-.. automodule:: certbot.display.util
-   :members:
-
-:mod:`certbot.display.ops`
-==============================
-
-.. automodule:: certbot.display.ops
-   :members:
@@ -1,5 +0,0 @@
-:mod:`certbot.errors`
-------------------------
-
-.. automodule:: certbot.errors
-   :members:
@@ -1,5 +0,0 @@
-:mod:`certbot`
------------------
-
-.. automodule:: certbot
-   :members:
@@ -1,5 +0,0 @@
-:mod:`certbot.interfaces`
-----------------------------
-
-.. automodule:: certbot.interfaces
-   :members:
@@ -1,5 +0,0 @@
-:mod:`certbot.main`
------------------------------
-
-.. automodule:: certbot.main
-   :members:
@@ -1,5 +0,0 @@
-:mod:`certbot.plugins.common`
---------------------------------
-
-.. automodule:: certbot.plugins.common
-   :members:
@@ -1,5 +0,0 @@
-:mod:`certbot.plugins.dns_common`
---------------------------------
-
-.. automodule:: certbot.plugins.dns_common
-   :members:
@@ -1,5 +0,0 @@
-:mod:`certbot.plugins.dns_common_lexicon`
-----------------------------------------
-
-.. automodule:: certbot.plugins.dns_common_lexicon
-   :members:
@@ -1,5 +0,0 @@
-:mod:`certbot.plugins.util`
-------------------------------
-
-.. automodule:: certbot.plugins.util
-   :members:
@@ -1,5 +0,0 @@
-:mod:`certbot.reverter`
---------------------------
-
-.. automodule:: certbot.reverter
-   :members:
@@ -1,5 +0,0 @@
-:mod:`certbot.util`
--------------------------
-
-.. automodule:: certbot.util
-   :members: