Split docs into subpkgs (fixes #969)

letsencrypt-compatibility-test/docs/api.rst

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

letsencrypt-compatibility-test/docs/api/index.rst

@@ -0,0 +1,53 @@
+:mod:`letsencrypt_compatibility_test`
+-------------------------------------
+
+.. automodule:: letsencrypt_compatibility_test
+   :members:
+
+:mod:`letsencrypt_compatibility_test.errors`
+============================================
+
+.. automodule:: letsencrypt_compatibility_test.errors
+   :members:
+
+:mod:`letsencrypt_compatibility_test.interfaces`
+================================================
+
+.. automodule:: letsencrypt_compatibility_test.interfaces
+   :members:
+
+:mod:`letsencrypt_compatibility_test.test_driver`
+=================================================
+
+.. automodule:: letsencrypt_compatibility_test.test_driver
+   :members:
+
+:mod:`letsencrypt_compatibility_test.util`
+==========================================
+
+.. automodule:: letsencrypt_compatibility_test.util
+   :members:
+
+:mod:`letsencrypt_compatibility_test.configurators`
+===================================================
+
+.. automodule:: letsencrypt_compatibility_test.configurators
+   :members:
+
+:mod:`letsencrypt_compatibility_test.configurators.apache`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: letsencrypt_compatibility_test.configurators.apache
+   :members:
+
+:mod:`letsencrypt_compatibility_test.configurators.apache.apache24`
+-------------------------------------------------------------------
+
+.. automodule:: letsencrypt_compatibility_test.configurators.apache.apache24
+   :members:
+
+:mod:`letsencrypt_compatibility_test.configurators.apache.common`
+-------------------------------------------------------------------
+
+.. automodule:: letsencrypt_compatibility_test.configurators.apache.common
+   :members:

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