upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-06-03 13:59:02 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Add full API documentation (#7614)

Browse source 
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`.
This commit is contained in:
Brad Warren 2019-12-03 09:54:37 -08:00 committed by GitHub
parent 27d6f62a96
commit 3cfa63483d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
41 changed files with 258 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
certbot/docs/api.rst
View file

@ -3,6 +3,6 @@ API Documentation
=================
.. toctree::
:glob:
:maxdepth: 4
api/**
api/certbot

5
certbot/docs/api/achallenges.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot.achallenges`
------------------------------
.. automodule:: certbot.achallenges
:members:

7
certbot/docs/api/certbot.achallenges.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.achallenges module
==========================
.. automodule:: certbot.achallenges
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.compat.filesystem.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.compat.filesystem module
================================
.. automodule:: certbot.compat.filesystem
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.compat.misc.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.compat.misc module
==========================
.. automodule:: certbot.compat.misc
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.compat.os.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.compat.os module
========================
.. automodule:: certbot.compat.os
:members:
:undoc-members:
:show-inheritance:

17
certbot/docs/api/certbot.compat.rst Normal file
View file

@ -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

7
certbot/docs/api/certbot.crypto_util.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.crypto\_util module
===========================
.. automodule:: certbot.crypto_util
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.display.ops.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.display.ops module
==========================
.. automodule:: certbot.display.ops
:members:
:undoc-members:
:show-inheritance:

16
certbot/docs/api/certbot.display.rst Normal file
View file

@ -0,0 +1,16 @@
certbot.display package
=======================
.. automodule:: certbot.display
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
.. toctree::
certbot.display.ops
certbot.display.util

7
certbot/docs/api/certbot.display.util.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.display.util module
===========================
.. automodule:: certbot.display.util
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.errors.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.errors module
=====================
.. automodule:: certbot.errors
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.interfaces.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.interfaces module
=========================
.. automodule:: certbot.interfaces
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.main.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.main module
===================
.. automodule:: certbot.main
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.plugins.common.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.plugins.common module
=============================
.. automodule:: certbot.plugins.common
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.plugins.dns_common.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.plugins.dns\_common module
==================================
.. automodule:: certbot.plugins.dns_common
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.plugins.dns_common_lexicon.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.plugins.dns\_common\_lexicon module
===========================================
.. automodule:: certbot.plugins.dns_common_lexicon
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.plugins.dns_test_common.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.plugins.dns\_test\_common module
========================================
.. automodule:: certbot.plugins.dns_test_common
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.plugins.dns_test_common_lexicon.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.plugins.dns\_test\_common\_lexicon module
=================================================
.. automodule:: certbot.plugins.dns_test_common_lexicon
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.plugins.enhancements.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.plugins.enhancements module
===================================
.. automodule:: certbot.plugins.enhancements
:members:
:undoc-members:
:show-inheritance:

22
certbot/docs/api/certbot.plugins.rst Normal file
View file

@ -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

7
certbot/docs/api/certbot.plugins.storage.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.plugins.storage module
==============================
.. automodule:: certbot.plugins.storage
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.plugins.util.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.plugins.util module
===========================
.. automodule:: certbot.plugins.util
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.reverter.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.reverter module
=======================
.. automodule:: certbot.reverter
:members:
:undoc-members:
:show-inheritance:

31
certbot/docs/api/certbot.rst Normal file
View file

@ -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

7
certbot/docs/api/certbot.tests.acme_util.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.tests.acme\_util module
===============================
.. automodule:: certbot.tests.acme_util
:members:
:undoc-members:
:show-inheritance:

16
certbot/docs/api/certbot.tests.rst Normal file
View file

@ -0,0 +1,16 @@
certbot.tests package
=====================
.. automodule:: certbot.tests
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
.. toctree::
certbot.tests.acme_util
certbot.tests.util

7
certbot/docs/api/certbot.tests.util.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.tests.util module
=========================
.. automodule:: certbot.tests.util
:members:
:undoc-members:
:show-inheritance:

7
certbot/docs/api/certbot.util.rst Normal file
View file

@ -0,0 +1,7 @@
certbot.util module
===================
.. automodule:: certbot.util
:members:
:undoc-members:
:show-inheritance:

5
certbot/docs/api/crypto_util.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot.crypto_util`
------------------------------
.. automodule:: certbot.crypto_util
:members:

17
certbot/docs/api/display.rst
View file

@ -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:

5
certbot/docs/api/errors.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot.errors`
-------------------------
.. automodule:: certbot.errors
:members:

5
certbot/docs/api/index.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot`
------------------
.. automodule:: certbot
:members:

5
certbot/docs/api/interfaces.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot.interfaces`
-----------------------------
.. automodule:: certbot.interfaces
:members:

5
certbot/docs/api/main.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot.main`
------------------------------
.. automodule:: certbot.main
:members:

5
certbot/docs/api/plugins/common.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot.plugins.common`
---------------------------------
.. automodule:: certbot.plugins.common
:members:

5
certbot/docs/api/plugins/dns_common.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot.plugins.dns_common`
---------------------------------
.. automodule:: certbot.plugins.dns_common
:members:

5
certbot/docs/api/plugins/dns_common_lexicon.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot.plugins.dns_common_lexicon`
-----------------------------------------
.. automodule:: certbot.plugins.dns_common_lexicon
:members:

5
certbot/docs/api/plugins/util.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot.plugins.util`
-------------------------------
.. automodule:: certbot.plugins.util
:members:

5
certbot/docs/api/reverter.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot.reverter`
---------------------------
.. automodule:: certbot.reverter
:members:

5
certbot/docs/api/util.rst
View file

@ -1,5 +0,0 @@
:mod:`certbot.util`
--------------------------
.. automodule:: certbot.util
:members: