Split docs into subpkgs (fixes #969)

acme/docs/api.rst

@@ -0,0 +1,8 @@
+=================
+API Documentation
+=================
+
+.. toctree::
+   :glob:
+
+   api/**

acme/docs/conf.py

@@ -16,10 +16,14 @@ import sys
 import os
 import shlex
 
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath(os.path.join(here, '..')))
 
 # -- General configuration ------------------------------------------------
 
@@ -271,7 +275,8 @@ latex_documents = [
 # (source start file, name, description, authors, manual section).
 man_pages = [
     (master_doc, 'acme-python', u'acme-python Documentation',
-     [author], 1)
+     [author], 1),
+    ('man/jws', 'jws', u'jws script documentation', [project], 1),
 ]
 
 # If true, show URL addresses after external links.

acme/docs/index.rst

@@ -11,6 +11,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   api
 
 
 Indices and tables

docs/conf.py

@@ -17,13 +17,6 @@ import os
 import re
 import sys
 
-import mock
-
-
-# http://docs.readthedocs.org/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
-# c.f. #262
-sys.modules.update(
-    (mod_name, mock.MagicMock()) for mod_name in ['augeas'])
 
 here = os.path.abspath(os.path.dirname(__file__))
 
@@ -36,8 +29,6 @@ with codecs.open(init_fn, encoding='utf8') as fd:
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath(os.path.join(here, '..')))
-for pkg in 'acme', 'letsencrypt-apache', 'letsencrypt-nginx':
-    sys.path.insert(0, os.path.abspath(os.path.join(here, '..', pkg)))
 
 # -- General configuration ------------------------------------------------
 
@@ -292,7 +283,6 @@ man_pages = [
      [project], 1),
     ('man/letsencrypt-renewer', 'letsencrypt-renewer',
      u'letsencrypt-renewer script documentation', [project], 1),
-    ('man/jws', 'jws', u'jws script documentation', [project], 1),
 ]
 
 # If true, show URL addresses after external links.

docs/contributing.rst

@@ -84,14 +84,8 @@ run (in a separate terminal)::
 
 If you would like to test `letsencrypt_nginx` plugin (highly
 encouraged) make sure to install prerequisites as listed in
-``letsencrypt-nginx/tests/boulder-integration.sh``:
-
-.. include:: ../letsencrypt-nginx/tests/boulder-integration.sh
-   :start-line: 1
-   :end-line: 2
-   :code: shell
-
-and rerun the integration tests suite.
+``letsencrypt-nginx/tests/boulder-integration.sh`` and rerun
+the integration tests suite.
 
 .. _Boulder: https://github.com/letsencrypt/boulder
 .. _Go: https://golang.org

docs/index.rst

@@ -13,7 +13,6 @@ Welcome to the Let's Encrypt client documentation!
    :maxdepth: 1
 
    api
-   pkgs
 
 
 Indices and tables

docs/pkgs.rst

@@ -1,14 +0,0 @@
-========
-Packages
-========
-
-.. note:: It is planned to distribute `acme` and plugins separately as
-  described in `#358`_. For the time being those packages are bundled
-  together into a single repo, and single documentation.
-
-.. _`#358`: https://github.com/letsencrypt/letsencrypt/issues/358
-
-.. toctree::
-   :glob:
-
-   pkgs/**

letsencrypt-apache/docs/api.rst

@@ -0,0 +1,8 @@
+=================
+API Documentation
+=================
+
+.. toctree::
+   :glob:
+
+   api/**

letsencrypt-apache/docs/conf.py

@@ -16,10 +16,20 @@ import sys
 import os
 import shlex
 
+import mock
+
+
+# http://docs.readthedocs.org/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
+# c.f. #262
+sys.modules.update(
+    (mod_name, mock.MagicMock()) for mod_name in ['augeas'])
+
+here = os.path.abspath(os.path.dirname(__file__))
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath(os.path.join(here, '..')))
 
 # -- General configuration ------------------------------------------------
 

letsencrypt-apache/docs/index.rst

@@ -12,6 +12,11 @@ Contents:
    :maxdepth: 2
 
 
+.. toctree::
+   :maxdepth: 1
+
+   api
+
 
 Indices and tables
 ==================

letsencrypt-compatibility-test/docs/api.rst

@@ -0,0 +1,8 @@
+=================
+API Documentation
+=================
+
+.. toctree::
+   :glob:
+
+   api/**

letsencrypt-compatibility-test/docs/conf.py

@@ -16,10 +16,13 @@ import sys
 import os
 import shlex
 
+
+here = os.path.abspath(os.path.dirname(__file__))
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath(os.path.join(here, '..')))
 
 # -- General configuration ------------------------------------------------
 

letsencrypt-compatibility-test/docs/index.rst

@@ -12,6 +12,11 @@ Contents:
    :maxdepth: 2
 
 
+.. toctree::
+   :maxdepth: 1
+
+   api
+
 
 Indices and tables
 ==================

letsencrypt-nginx/docs/api.rst

@@ -0,0 +1,8 @@
+=================
+API Documentation
+=================
+
+.. toctree::
+   :glob:
+
+   api/**

letsencrypt-nginx/docs/conf.py

@@ -16,10 +16,13 @@ import sys
 import os
 import shlex
 
+
+here = os.path.abspath(os.path.dirname(__file__))
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath(os.path.join(here, '..')))
 
 # -- General configuration ------------------------------------------------
 

letsencrypt-nginx/docs/index.rst

@@ -12,6 +12,11 @@ Contents:
    :maxdepth: 2
 
 
+.. toctree::
+   :maxdepth: 1
+
+   api
+
 
 Indices and tables
 ==================

letshelp-letsencrypt/docs/api.rst

@@ -0,0 +1,8 @@
+=================
+API Documentation
+=================
+
+.. toctree::
+   :glob:
+
+   api/**

letshelp-letsencrypt/docs/conf.py

@@ -16,10 +16,13 @@ import sys
 import os
 import shlex
 
+
+here = os.path.abspath(os.path.dirname(__file__))
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath(os.path.join(here, '..')))
 
 # -- General configuration ------------------------------------------------
 

letshelp-letsencrypt/docs/index.rst

@@ -12,6 +12,11 @@ Contents:
    :maxdepth: 2
 
 
+.. toctree::
+   :maxdepth: 1
+
+   api
+
 
 Indices and tables
 ==================