Doc checkup

This commit is contained in:
Brad Warren
2016-04-14 13:44:12 -07:00
parent 21173e2353
commit 6daa2dd042
27 changed files with 54 additions and 64 deletions
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.account` :mod:`certbot.account`
-------------------------- --------------------------
.. automodule:: letsencrypt.account .. automodule:: certbot.account
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.achallenges` :mod:`certbot.achallenges`
------------------------------ ------------------------------
.. automodule:: letsencrypt.achallenges .. automodule:: certbot.achallenges
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.auth_handler` :mod:`certbot.auth_handler`
------------------------------- -------------------------------
.. automodule:: letsencrypt.auth_handler .. automodule:: certbot.auth_handler
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.client` :mod:`certbot.client`
------------------------- -------------------------
.. automodule:: letsencrypt.client .. automodule:: certbot.client
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.configuration` :mod:`certbot.configuration`
-------------------------------- --------------------------------
.. automodule:: letsencrypt.configuration .. automodule:: certbot.configuration
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.constants` :mod:`certbot.constants`
----------------------------------- -----------------------------------
.. automodule:: letsencrypt.constants .. automodule:: certbot.constants
:members: :members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.continuity_auth`
----------------------------------
.. automodule:: letsencrypt.continuity_auth
:members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.crypto_util` :mod:`certbot.crypto_util`
------------------------------ ------------------------------
.. automodule:: letsencrypt.crypto_util .. automodule:: certbot.crypto_util
:members: :members:
+8 -8
View File
@@ -1,23 +1,23 @@
:mod:`letsencrypt.display` :mod:`certbot.display`
-------------------------- --------------------------
.. automodule:: letsencrypt.display .. automodule:: certbot.display
:members: :members:
:mod:`letsencrypt.display.util` :mod:`certbot.display.util`
=============================== ===============================
.. automodule:: letsencrypt.display.util .. automodule:: certbot.display.util
:members: :members:
:mod:`letsencrypt.display.ops` :mod:`certbot.display.ops`
============================== ==============================
.. automodule:: letsencrypt.display.ops .. automodule:: certbot.display.ops
:members: :members:
:mod:`letsencrypt.display.enhancements` :mod:`certbot.display.enhancements`
======================================= =======================================
.. automodule:: letsencrypt.display.enhancements .. automodule:: certbot.display.enhancements
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.errors` :mod:`certbot.errors`
------------------------- -------------------------
.. automodule:: letsencrypt.errors .. automodule:: certbot.errors
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt` :mod:`certbot`
------------------ ------------------
.. automodule:: letsencrypt .. automodule:: certbot
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.interfaces` :mod:`certbot.interfaces`
----------------------------- -----------------------------
.. automodule:: letsencrypt.interfaces .. automodule:: certbot.interfaces
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.le_util` :mod:`certbot.le_util`
-------------------------- --------------------------
.. automodule:: letsencrypt.le_util .. automodule:: certbot.le_util
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.log` :mod:`certbot.log`
---------------------- ----------------------
.. automodule:: letsencrypt.log .. automodule:: certbot.log
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.plugins.common` :mod:`certbot.plugins.common`
--------------------------------- ---------------------------------
.. automodule:: letsencrypt.plugins.common .. automodule:: certbot.plugins.common
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.plugins.disco` :mod:`certbot.plugins.disco`
-------------------------------- --------------------------------
.. automodule:: letsencrypt.plugins.disco .. automodule:: certbot.plugins.disco
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.plugins.manual` :mod:`certbot.plugins.manual`
--------------------------------- ---------------------------------
.. automodule:: letsencrypt.plugins.manual .. automodule:: certbot.plugins.manual
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.plugins.standalone` :mod:`certbot.plugins.standalone`
------------------------------------- -------------------------------------
.. automodule:: letsencrypt.plugins.standalone .. automodule:: certbot.plugins.standalone
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.plugins.util` :mod:`certbot.plugins.util`
------------------------------- -------------------------------
.. automodule:: letsencrypt.plugins.util .. automodule:: certbot.plugins.util
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.plugins.webroot` :mod:`certbot.plugins.webroot`
---------------------------------- ----------------------------------
.. automodule:: letsencrypt.plugins.webroot .. automodule:: certbot.plugins.webroot
:members: :members:
-5
View File
@@ -1,5 +0,0 @@
:mod:`letsencrypt.proof_of_possession`
--------------------------------------
.. automodule:: letsencrypt.proof_of_possession
:members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.reporter` :mod:`certbot.reporter`
--------------------------- ---------------------------
.. automodule:: letsencrypt.reporter .. automodule:: certbot.reporter
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.reverter` :mod:`certbot.reverter`
--------------------------- ---------------------------
.. automodule:: letsencrypt.reverter .. automodule:: certbot.reverter
:members: :members:
+2 -2
View File
@@ -1,5 +1,5 @@
:mod:`letsencrypt.storage` :mod:`certbot.storage`
-------------------------- --------------------------
.. automodule:: letsencrypt.storage .. automodule:: certbot.storage
:members: :members:
+3 -3
View File
@@ -21,7 +21,7 @@ import sys
here = os.path.abspath(os.path.dirname(__file__)) here = os.path.abspath(os.path.dirname(__file__))
# read version number (and other metadata) from package init # read version number (and other metadata) from package init
init_fn = os.path.join(here, '..', 'letsencrypt', '__init__.py') init_fn = os.path.join(here, '..', 'certbot', '__init__.py')
with codecs.open(init_fn, encoding='utf8') as fd: with codecs.open(init_fn, encoding='utf8') as fd:
meta = dict(re.findall(r"""__([a-z]+)__ = '([^']+)""", fd.read())) meta = dict(re.findall(r"""__([a-z]+)__ = '([^']+)""", fd.read()))
@@ -277,9 +277,9 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'letsencrypt', u'Let\'s Encrypt Documentation', ('index', 'certbot', u'Let\'s Encrypt Documentation',
[project], 7), [project], 7),
('man/letsencrypt', 'letsencrypt', u'letsencrypt script documentation', ('man/certbot', 'certbot', u'certbot script documentation',
[project], 1), [project], 1),
] ]
+1
View File
@@ -0,0 +1 @@
.. program-output:: certbot --help all
-1
View File
@@ -1 +0,0 @@
.. program-output:: letsencrypt --help all