Split docs into subpkgs (fixes #969)

letsencrypt-apache/docs/api.rst

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

letsencrypt-apache/docs/api/index.rst

@@ -0,0 +1,42 @@
+:mod:`letsencrypt_apache`
+-------------------------
+
+.. automodule:: letsencrypt_apache
+   :members:
+
+:mod:`letsencrypt_apache.configurator`
+======================================
+
+.. automodule:: letsencrypt_apache.configurator
+   :members:
+
+:mod:`letsencrypt_apache.display_ops`
+=====================================
+
+.. automodule:: letsencrypt_apache.display_ops
+   :members:
+
+:mod:`letsencrypt_apache.dvsni`
+===============================
+
+.. automodule:: letsencrypt_apache.dvsni
+   :members:
+
+:mod:`letsencrypt_apache.obj`
+=============================
+
+.. automodule:: letsencrypt_apache.obj
+   :members:
+
+:mod:`letsencrypt_apache.parser`
+================================
+
+.. automodule:: letsencrypt_apache.parser
+   :members:
+
+
+:mod:`letsencrypt_apache.augeas_configurator`
+=============================================
+
+.. automodule:: letsencrypt_apache.augeas_configurator
+   :members:

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