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`.

41 files changed, 258 insertions, 79 deletions

diff --git a/certbot/docs/api.rst b/certbot/docs/api.rst
index 8668ec5d8..9c8b2f1fe 100644
--- a/certbot/docs/api.rst
+++ b/certbot/docs/api.rst
@@ -3,6 +3,6 @@ API Documentation
 =================
 
 .. toctree::
-   :glob:
+   :maxdepth: 4
 
-   api/**
+   api/certbot
diff --git a/certbot/docs/api/achallenges.rst b/certbot/docs/api/achallenges.rst
deleted file mode 100644
index 90dda3f06..000000000
--- a/certbot/docs/api/achallenges.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot.achallenges`
-------------------------------
-
-.. automodule:: certbot.achallenges
-   :members:
diff --git a/certbot/docs/api/certbot.achallenges.rst b/certbot/docs/api/certbot.achallenges.rst
new file mode 100644
index 000000000..3fd2f2a42
--- /dev/null
+++ b/certbot/docs/api/certbot.achallenges.rst
@@ -0,0 +1,7 @@
+certbot.achallenges module
+==========================
+
+.. automodule:: certbot.achallenges
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.compat.filesystem.rst b/certbot/docs/api/certbot.compat.filesystem.rst
new file mode 100644
index 000000000..d4f1e2fe0
--- /dev/null
+++ b/certbot/docs/api/certbot.compat.filesystem.rst
@@ -0,0 +1,7 @@
+certbot.compat.filesystem module
+================================
+
+.. automodule:: certbot.compat.filesystem
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.compat.misc.rst b/certbot/docs/api/certbot.compat.misc.rst
new file mode 100644
index 000000000..35c2913e7
--- /dev/null
+++ b/certbot/docs/api/certbot.compat.misc.rst
@@ -0,0 +1,7 @@
+certbot.compat.misc module
+==========================
+
+.. automodule:: certbot.compat.misc
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.compat.os.rst b/certbot/docs/api/certbot.compat.os.rst
new file mode 100644
index 000000000..3a4c9fe47
--- /dev/null
+++ b/certbot/docs/api/certbot.compat.os.rst
@@ -0,0 +1,7 @@
+certbot.compat.os module
+========================
+
+.. automodule:: certbot.compat.os
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.compat.rst b/certbot/docs/api/certbot.compat.rst
new file mode 100644
index 000000000..f6f2b3739
--- /dev/null
+++ b/certbot/docs/api/certbot.compat.rst
@@ -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
+
diff --git a/certbot/docs/api/certbot.crypto_util.rst b/certbot/docs/api/certbot.crypto_util.rst
new file mode 100644
index 000000000..34aa665b9
--- /dev/null
+++ b/certbot/docs/api/certbot.crypto_util.rst
@@ -0,0 +1,7 @@
+certbot.crypto\_util module
+===========================
+
+.. automodule:: certbot.crypto_util
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.display.ops.rst b/certbot/docs/api/certbot.display.ops.rst
new file mode 100644
index 000000000..544b0dad3
--- /dev/null
+++ b/certbot/docs/api/certbot.display.ops.rst
@@ -0,0 +1,7 @@
+certbot.display.ops module
+==========================
+
+.. automodule:: certbot.display.ops
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.display.rst b/certbot/docs/api/certbot.display.rst
new file mode 100644
index 000000000..04bc68b07
--- /dev/null
+++ b/certbot/docs/api/certbot.display.rst
@@ -0,0 +1,16 @@
+certbot.display package
+=======================
+
+.. automodule:: certbot.display
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   certbot.display.ops
+   certbot.display.util
+
diff --git a/certbot/docs/api/certbot.display.util.rst b/certbot/docs/api/certbot.display.util.rst
new file mode 100644
index 000000000..22b59dc98
--- /dev/null
+++ b/certbot/docs/api/certbot.display.util.rst
@@ -0,0 +1,7 @@
+certbot.display.util module
+===========================
+
+.. automodule:: certbot.display.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.errors.rst b/certbot/docs/api/certbot.errors.rst
new file mode 100644
index 000000000..731b7695d
--- /dev/null
+++ b/certbot/docs/api/certbot.errors.rst
@@ -0,0 +1,7 @@
+certbot.errors module
+=====================
+
+.. automodule:: certbot.errors
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.interfaces.rst b/certbot/docs/api/certbot.interfaces.rst
new file mode 100644
index 000000000..2665aaa01
--- /dev/null
+++ b/certbot/docs/api/certbot.interfaces.rst
@@ -0,0 +1,7 @@
+certbot.interfaces module
+=========================
+
+.. automodule:: certbot.interfaces
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.main.rst b/certbot/docs/api/certbot.main.rst
new file mode 100644
index 000000000..ce0539f5c
--- /dev/null
+++ b/certbot/docs/api/certbot.main.rst
@@ -0,0 +1,7 @@
+certbot.main module
+===================
+
+.. automodule:: certbot.main
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.plugins.common.rst b/certbot/docs/api/certbot.plugins.common.rst
new file mode 100644
index 000000000..e94b2d12e
--- /dev/null
+++ b/certbot/docs/api/certbot.plugins.common.rst
@@ -0,0 +1,7 @@
+certbot.plugins.common module
+=============================
+
+.. automodule:: certbot.plugins.common
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.plugins.dns_common.rst b/certbot/docs/api/certbot.plugins.dns_common.rst
new file mode 100644
index 000000000..36c7a6428
--- /dev/null
+++ b/certbot/docs/api/certbot.plugins.dns_common.rst
@@ -0,0 +1,7 @@
+certbot.plugins.dns\_common module
+==================================
+
+.. automodule:: certbot.plugins.dns_common
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.plugins.dns_common_lexicon.rst b/certbot/docs/api/certbot.plugins.dns_common_lexicon.rst
new file mode 100644
index 000000000..1a961accd
--- /dev/null
+++ b/certbot/docs/api/certbot.plugins.dns_common_lexicon.rst
@@ -0,0 +1,7 @@
+certbot.plugins.dns\_common\_lexicon module
+===========================================
+
+.. automodule:: certbot.plugins.dns_common_lexicon
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.plugins.dns_test_common.rst b/certbot/docs/api/certbot.plugins.dns_test_common.rst
new file mode 100644
index 000000000..69e672f0a
--- /dev/null
+++ b/certbot/docs/api/certbot.plugins.dns_test_common.rst
@@ -0,0 +1,7 @@
+certbot.plugins.dns\_test\_common module
+========================================
+
+.. automodule:: certbot.plugins.dns_test_common
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.plugins.dns_test_common_lexicon.rst b/certbot/docs/api/certbot.plugins.dns_test_common_lexicon.rst
new file mode 100644
index 000000000..92d516c99
--- /dev/null
+++ b/certbot/docs/api/certbot.plugins.dns_test_common_lexicon.rst
@@ -0,0 +1,7 @@
+certbot.plugins.dns\_test\_common\_lexicon module
+=================================================
+
+.. automodule:: certbot.plugins.dns_test_common_lexicon
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.plugins.enhancements.rst b/certbot/docs/api/certbot.plugins.enhancements.rst
new file mode 100644
index 000000000..16db737c7
--- /dev/null
+++ b/certbot/docs/api/certbot.plugins.enhancements.rst
@@ -0,0 +1,7 @@
+certbot.plugins.enhancements module
+===================================
+
+.. automodule:: certbot.plugins.enhancements
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.plugins.rst b/certbot/docs/api/certbot.plugins.rst
new file mode 100644
index 000000000..517a209e6
--- /dev/null
+++ b/certbot/docs/api/certbot.plugins.rst
@@ -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
+
diff --git a/certbot/docs/api/certbot.plugins.storage.rst b/certbot/docs/api/certbot.plugins.storage.rst
new file mode 100644
index 000000000..9ed0fe724
--- /dev/null
+++ b/certbot/docs/api/certbot.plugins.storage.rst
@@ -0,0 +1,7 @@
+certbot.plugins.storage module
+==============================
+
+.. automodule:: certbot.plugins.storage
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.plugins.util.rst b/certbot/docs/api/certbot.plugins.util.rst
new file mode 100644
index 000000000..c5453564e
--- /dev/null
+++ b/certbot/docs/api/certbot.plugins.util.rst
@@ -0,0 +1,7 @@
+certbot.plugins.util module
+===========================
+
+.. automodule:: certbot.plugins.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.reverter.rst b/certbot/docs/api/certbot.reverter.rst
new file mode 100644
index 000000000..002b75360
--- /dev/null
+++ b/certbot/docs/api/certbot.reverter.rst
@@ -0,0 +1,7 @@
+certbot.reverter module
+=======================
+
+.. automodule:: certbot.reverter
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.rst b/certbot/docs/api/certbot.rst
new file mode 100644
index 000000000..6f5b4b403
--- /dev/null
+++ b/certbot/docs/api/certbot.rst
@@ -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
+
diff --git a/certbot/docs/api/certbot.tests.acme_util.rst b/certbot/docs/api/certbot.tests.acme_util.rst
new file mode 100644
index 000000000..908397596
--- /dev/null
+++ b/certbot/docs/api/certbot.tests.acme_util.rst
@@ -0,0 +1,7 @@
+certbot.tests.acme\_util module
+===============================
+
+.. automodule:: certbot.tests.acme_util
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.tests.rst b/certbot/docs/api/certbot.tests.rst
new file mode 100644
index 000000000..336f0eabc
--- /dev/null
+++ b/certbot/docs/api/certbot.tests.rst
@@ -0,0 +1,16 @@
+certbot.tests package
+=====================
+
+.. automodule:: certbot.tests
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   certbot.tests.acme_util
+   certbot.tests.util
+
diff --git a/certbot/docs/api/certbot.tests.util.rst b/certbot/docs/api/certbot.tests.util.rst
new file mode 100644
index 000000000..3f0335849
--- /dev/null
+++ b/certbot/docs/api/certbot.tests.util.rst
@@ -0,0 +1,7 @@
+certbot.tests.util module
+=========================
+
+.. automodule:: certbot.tests.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/certbot.util.rst b/certbot/docs/api/certbot.util.rst
new file mode 100644
index 000000000..11cb33b09
--- /dev/null
+++ b/certbot/docs/api/certbot.util.rst
@@ -0,0 +1,7 @@
+certbot.util module
+===================
+
+.. automodule:: certbot.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/certbot/docs/api/crypto_util.rst b/certbot/docs/api/crypto_util.rst
deleted file mode 100644
index 2f473944c..000000000
--- a/certbot/docs/api/crypto_util.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot.crypto_util`
-------------------------------
-
-.. automodule:: certbot.crypto_util
-   :members:
diff --git a/certbot/docs/api/display.rst b/certbot/docs/api/display.rst
deleted file mode 100644
index 70038786c..000000000
--- a/certbot/docs/api/display.rst
+++ /dev/null
@@ -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:
diff --git a/certbot/docs/api/errors.rst b/certbot/docs/api/errors.rst
deleted file mode 100644
index a9324765b..000000000
--- a/certbot/docs/api/errors.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot.errors`
--------------------------
-
-.. automodule:: certbot.errors
-   :members:
diff --git a/certbot/docs/api/index.rst b/certbot/docs/api/index.rst
deleted file mode 100644
index be94214c9..000000000
--- a/certbot/docs/api/index.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot`
-------------------
-
-.. automodule:: certbot
-   :members:
diff --git a/certbot/docs/api/interfaces.rst b/certbot/docs/api/interfaces.rst
deleted file mode 100644
index 2988b3b87..000000000
--- a/certbot/docs/api/interfaces.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot.interfaces`
------------------------------
-
-.. automodule:: certbot.interfaces
-   :members:
diff --git a/certbot/docs/api/main.rst b/certbot/docs/api/main.rst
deleted file mode 100644
index d9dda841d..000000000
--- a/certbot/docs/api/main.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot.main`
-------------------------------
-
-.. automodule:: certbot.main
-   :members:
diff --git a/certbot/docs/api/plugins/common.rst b/certbot/docs/api/plugins/common.rst
deleted file mode 100644
index 7cfaf8d70..000000000
--- a/certbot/docs/api/plugins/common.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot.plugins.common`
----------------------------------
-
-.. automodule:: certbot.plugins.common
-   :members:
diff --git a/certbot/docs/api/plugins/dns_common.rst b/certbot/docs/api/plugins/dns_common.rst
deleted file mode 100644
index ee3945e74..000000000
--- a/certbot/docs/api/plugins/dns_common.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot.plugins.dns_common`
----------------------------------
-
-.. automodule:: certbot.plugins.dns_common
-   :members:
diff --git a/certbot/docs/api/plugins/dns_common_lexicon.rst b/certbot/docs/api/plugins/dns_common_lexicon.rst
deleted file mode 100644
index a48166828..000000000
--- a/certbot/docs/api/plugins/dns_common_lexicon.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot.plugins.dns_common_lexicon`
------------------------------------------
-
-.. automodule:: certbot.plugins.dns_common_lexicon
-   :members:
diff --git a/certbot/docs/api/plugins/util.rst b/certbot/docs/api/plugins/util.rst
deleted file mode 100644
index 30ab3d49f..000000000
--- a/certbot/docs/api/plugins/util.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot.plugins.util`
--------------------------------
-
-.. automodule:: certbot.plugins.util
-   :members:
diff --git a/certbot/docs/api/reverter.rst b/certbot/docs/api/reverter.rst
deleted file mode 100644
index 3e0ac750b..000000000
--- a/certbot/docs/api/reverter.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot.reverter`
----------------------------
-
-.. automodule:: certbot.reverter
-   :members:
diff --git a/certbot/docs/api/util.rst b/certbot/docs/api/util.rst
deleted file mode 100644
index 7d0e33501..000000000
--- a/certbot/docs/api/util.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`certbot.util`
---------------------------
-
-.. automodule:: certbot.util
-   :members: