Doc checkup

zone-h · Apr 14, 2016 · 6daa2dd · 6daa2dd
1 parent 21173e2
commit 6daa2dd
Show file tree

Hide file tree

Showing 27 changed files with 54 additions and 64 deletions.
diff --git a/docs/api/account.rst b/docs/api/account.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.account`
+:mod:`certbot.account`
 --------------------------
 
-.. automodule:: letsencrypt.account
+.. automodule:: certbot.account
    :members:
diff --git a/docs/api/achallenges.rst b/docs/api/achallenges.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.achallenges`
+:mod:`certbot.achallenges`
 ------------------------------
 
-.. automodule:: letsencrypt.achallenges
+.. automodule:: certbot.achallenges
    :members:
diff --git a/docs/api/auth_handler.rst b/docs/api/auth_handler.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.auth_handler`
+:mod:`certbot.auth_handler`
 -------------------------------
 
-.. automodule:: letsencrypt.auth_handler
+.. automodule:: certbot.auth_handler
    :members:
diff --git a/docs/api/client.rst b/docs/api/client.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.client`
+:mod:`certbot.client`
 -------------------------
 
-.. automodule:: letsencrypt.client
+.. automodule:: certbot.client
    :members:
diff --git a/docs/api/configuration.rst b/docs/api/configuration.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.configuration`
+:mod:`certbot.configuration`
 --------------------------------
 
-.. automodule:: letsencrypt.configuration
+.. automodule:: certbot.configuration
    :members:
diff --git a/docs/api/constants.rst b/docs/api/constants.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.constants`
+:mod:`certbot.constants`
 -----------------------------------
 
-.. automodule:: letsencrypt.constants
+.. automodule:: certbot.constants
    :members:
diff --git a/docs/api/continuity_auth.rst b/docs/api/continuity_auth.rst
diff --git a/docs/api/crypto_util.rst b/docs/api/crypto_util.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.crypto_util`
+:mod:`certbot.crypto_util`
 ------------------------------
 
-.. automodule:: letsencrypt.crypto_util
+.. automodule:: certbot.crypto_util
    :members:
diff --git a/docs/api/display.rst b/docs/api/display.rst
@@ -1,23 +1,23 @@
-:mod:`letsencrypt.display`
+:mod:`certbot.display`
 --------------------------
 
-.. automodule:: letsencrypt.display
+.. automodule:: certbot.display
    :members:
 
-:mod:`letsencrypt.display.util`
+:mod:`certbot.display.util`
 ===============================
 
-.. automodule:: letsencrypt.display.util
+.. automodule:: certbot.display.util
    :members:
 
-:mod:`letsencrypt.display.ops`
+:mod:`certbot.display.ops`
 ==============================
 
-.. automodule:: letsencrypt.display.ops
+.. automodule:: certbot.display.ops
    :members:
 
-:mod:`letsencrypt.display.enhancements`
+:mod:`certbot.display.enhancements`
 =======================================
 
-.. automodule:: letsencrypt.display.enhancements
+.. automodule:: certbot.display.enhancements
    :members:
diff --git a/docs/api/errors.rst b/docs/api/errors.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.errors`
+:mod:`certbot.errors`
 -------------------------
 
-.. automodule:: letsencrypt.errors
+.. automodule:: certbot.errors
    :members:
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt`
+:mod:`certbot`
 ------------------
 
-.. automodule:: letsencrypt
+.. automodule:: certbot
    :members:
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.interfaces`
+:mod:`certbot.interfaces`
 -----------------------------
 
-.. automodule:: letsencrypt.interfaces
+.. automodule:: certbot.interfaces
    :members:
diff --git a/docs/api/le_util.rst b/docs/api/le_util.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.le_util`
+:mod:`certbot.le_util`
 --------------------------
 
-.. automodule:: letsencrypt.le_util
+.. automodule:: certbot.le_util
    :members:
diff --git a/docs/api/log.rst b/docs/api/log.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.log`
+:mod:`certbot.log`
 ----------------------
 
-.. automodule:: letsencrypt.log
+.. automodule:: certbot.log
    :members:
diff --git a/docs/api/plugins/common.rst b/docs/api/plugins/common.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.plugins.common`
+:mod:`certbot.plugins.common`
 ---------------------------------
 
-.. automodule:: letsencrypt.plugins.common
+.. automodule:: certbot.plugins.common
    :members:
diff --git a/docs/api/plugins/disco.rst b/docs/api/plugins/disco.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.plugins.disco`
+:mod:`certbot.plugins.disco`
 --------------------------------
 
-.. automodule:: letsencrypt.plugins.disco
+.. automodule:: certbot.plugins.disco
    :members:
diff --git a/docs/api/plugins/manual.rst b/docs/api/plugins/manual.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.plugins.manual`
+:mod:`certbot.plugins.manual`
 ---------------------------------
 
-.. automodule:: letsencrypt.plugins.manual
+.. automodule:: certbot.plugins.manual
    :members:
diff --git a/docs/api/plugins/standalone.rst b/docs/api/plugins/standalone.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.plugins.standalone`
+:mod:`certbot.plugins.standalone`
 -------------------------------------
 
-.. automodule:: letsencrypt.plugins.standalone
+.. automodule:: certbot.plugins.standalone
    :members:
diff --git a/docs/api/plugins/util.rst b/docs/api/plugins/util.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.plugins.util`
+:mod:`certbot.plugins.util`
 -------------------------------
 
-.. automodule:: letsencrypt.plugins.util
+.. automodule:: certbot.plugins.util
    :members:
diff --git a/docs/api/plugins/webroot.rst b/docs/api/plugins/webroot.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.plugins.webroot`
+:mod:`certbot.plugins.webroot`
 ----------------------------------
 
-.. automodule:: letsencrypt.plugins.webroot
+.. automodule:: certbot.plugins.webroot
    :members:
diff --git a/docs/api/proof_of_possession.rst b/docs/api/proof_of_possession.rst
diff --git a/docs/api/reporter.rst b/docs/api/reporter.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.reporter`
+:mod:`certbot.reporter`
 ---------------------------
 
-.. automodule:: letsencrypt.reporter
+.. automodule:: certbot.reporter
    :members:
diff --git a/docs/api/reverter.rst b/docs/api/reverter.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.reverter`
+:mod:`certbot.reverter`
 ---------------------------
 
-.. automodule:: letsencrypt.reverter
+.. automodule:: certbot.reverter
    :members:
diff --git a/docs/api/storage.rst b/docs/api/storage.rst
@@ -1,5 +1,5 @@
-:mod:`letsencrypt.storage`
+:mod:`certbot.storage`
 --------------------------
 
-.. automodule:: letsencrypt.storage
+.. automodule:: certbot.storage
    :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -21,7 +21,7 @@
 here = os.path.abspath(os.path.dirname(__file__))
 
 # 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:
     meta = dict(re.findall(r"""__([a-z]+)__ = '([^']+)""", fd.read()))
 
@@ -277,9 +277,9 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'letsencrypt', u'Let\'s Encrypt Documentation',
+    ('index', 'certbot', u'Let\'s Encrypt Documentation',
      [project], 7),
-    ('man/letsencrypt', 'letsencrypt', u'letsencrypt script documentation',
+    ('man/certbot', 'certbot', u'certbot script documentation',
      [project], 1),
 ]
 

diff --git a/docs/man/certbot.rst b/docs/man/certbot.rst
@@ -0,0 +1 @@
+.. program-output:: certbot --help all
diff --git a/docs/man/letsencrypt.rst b/docs/man/letsencrypt.rst