diff --git a/acme/docs/api.rst b/acme/docs/api.rst new file mode 100644 index 000000000..8668ec5d8 --- /dev/null +++ b/acme/docs/api.rst @@ -0,0 +1,8 @@ +================= +API Documentation +================= + +.. toctree:: + :glob: + + api/** diff --git a/docs/pkgs/acme/index.rst b/acme/docs/api/index.rst similarity index 100% rename from docs/pkgs/acme/index.rst rename to acme/docs/api/index.rst diff --git a/docs/pkgs/acme/jose.rst b/acme/docs/api/jose.rst similarity index 100% rename from docs/pkgs/acme/jose.rst rename to acme/docs/api/jose.rst diff --git a/acme/docs/conf.py b/acme/docs/conf.py index dc5dec0ff..1448aaea3 100644 --- a/acme/docs/conf.py +++ b/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. diff --git a/acme/docs/index.rst b/acme/docs/index.rst index 357d73fd0..940d79037 100644 --- a/acme/docs/index.rst +++ b/acme/docs/index.rst @@ -11,6 +11,7 @@ Contents: .. toctree:: :maxdepth: 2 + api Indices and tables diff --git a/docs/man/jws.rst b/acme/docs/man/jws.rst similarity index 100% rename from docs/man/jws.rst rename to acme/docs/man/jws.rst diff --git a/docs/conf.py b/docs/conf.py index 2de0dd877..dad4e608f 100644 --- a/docs/conf.py +++ b/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. diff --git a/docs/contributing.rst b/docs/contributing.rst index 6b6550c71..60e7f35c2 100644 --- a/docs/contributing.rst +++ b/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 diff --git a/docs/index.rst b/docs/index.rst index b076b45c6..72be096f9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,7 +13,6 @@ Welcome to the Let's Encrypt client documentation! :maxdepth: 1 api - pkgs Indices and tables diff --git a/docs/pkgs.rst b/docs/pkgs.rst deleted file mode 100644 index 2e1b18dfb..000000000 --- a/docs/pkgs.rst +++ /dev/null @@ -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/** diff --git a/letsencrypt-apache/docs/api.rst b/letsencrypt-apache/docs/api.rst new file mode 100644 index 000000000..8668ec5d8 --- /dev/null +++ b/letsencrypt-apache/docs/api.rst @@ -0,0 +1,8 @@ +================= +API Documentation +================= + +.. toctree:: + :glob: + + api/** diff --git a/docs/pkgs/letsencrypt_apache.rst b/letsencrypt-apache/docs/api/index.rst similarity index 100% rename from docs/pkgs/letsencrypt_apache.rst rename to letsencrypt-apache/docs/api/index.rst diff --git a/letsencrypt-apache/docs/conf.py b/letsencrypt-apache/docs/conf.py index f578531db..e439428af 100644 --- a/letsencrypt-apache/docs/conf.py +++ b/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 ------------------------------------------------ diff --git a/letsencrypt-apache/docs/index.rst b/letsencrypt-apache/docs/index.rst index 64f0e3e14..9be7c20d5 100644 --- a/letsencrypt-apache/docs/index.rst +++ b/letsencrypt-apache/docs/index.rst @@ -12,6 +12,11 @@ Contents: :maxdepth: 2 +.. toctree:: + :maxdepth: 1 + + api + Indices and tables ================== diff --git a/letsencrypt-compatibility-test/docs/api.rst b/letsencrypt-compatibility-test/docs/api.rst new file mode 100644 index 000000000..8668ec5d8 --- /dev/null +++ b/letsencrypt-compatibility-test/docs/api.rst @@ -0,0 +1,8 @@ +================= +API Documentation +================= + +.. toctree:: + :glob: + + api/** diff --git a/docs/pkgs/letsencrypt_compatibility_test.rst b/letsencrypt-compatibility-test/docs/api/index.rst similarity index 100% rename from docs/pkgs/letsencrypt_compatibility_test.rst rename to letsencrypt-compatibility-test/docs/api/index.rst diff --git a/letsencrypt-compatibility-test/docs/conf.py b/letsencrypt-compatibility-test/docs/conf.py index 4ec0a1d9a..5a63c1dca 100644 --- a/letsencrypt-compatibility-test/docs/conf.py +++ b/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 ------------------------------------------------ diff --git a/letsencrypt-compatibility-test/docs/index.rst b/letsencrypt-compatibility-test/docs/index.rst index 3df442c65..df57ee6e6 100644 --- a/letsencrypt-compatibility-test/docs/index.rst +++ b/letsencrypt-compatibility-test/docs/index.rst @@ -12,6 +12,11 @@ Contents: :maxdepth: 2 +.. toctree:: + :maxdepth: 1 + + api + Indices and tables ================== diff --git a/letsencrypt-nginx/docs/api.rst b/letsencrypt-nginx/docs/api.rst new file mode 100644 index 000000000..8668ec5d8 --- /dev/null +++ b/letsencrypt-nginx/docs/api.rst @@ -0,0 +1,8 @@ +================= +API Documentation +================= + +.. toctree:: + :glob: + + api/** diff --git a/docs/pkgs/letsencrypt_nginx.rst b/letsencrypt-nginx/docs/api/index.rst similarity index 100% rename from docs/pkgs/letsencrypt_nginx.rst rename to letsencrypt-nginx/docs/api/index.rst diff --git a/letsencrypt-nginx/docs/conf.py b/letsencrypt-nginx/docs/conf.py index e8e320542..8bcae3a78 100644 --- a/letsencrypt-nginx/docs/conf.py +++ b/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 ------------------------------------------------ diff --git a/letsencrypt-nginx/docs/index.rst b/letsencrypt-nginx/docs/index.rst index c4822af52..94db969ab 100644 --- a/letsencrypt-nginx/docs/index.rst +++ b/letsencrypt-nginx/docs/index.rst @@ -12,6 +12,11 @@ Contents: :maxdepth: 2 +.. toctree:: + :maxdepth: 1 + + api + Indices and tables ================== diff --git a/letshelp-letsencrypt/docs/api.rst b/letshelp-letsencrypt/docs/api.rst new file mode 100644 index 000000000..8668ec5d8 --- /dev/null +++ b/letshelp-letsencrypt/docs/api.rst @@ -0,0 +1,8 @@ +================= +API Documentation +================= + +.. toctree:: + :glob: + + api/** diff --git a/docs/pkgs/letshelp_letsencrypt.rst b/letshelp-letsencrypt/docs/api/index.rst similarity index 100% rename from docs/pkgs/letshelp_letsencrypt.rst rename to letshelp-letsencrypt/docs/api/index.rst diff --git a/letshelp-letsencrypt/docs/conf.py b/letshelp-letsencrypt/docs/conf.py index 3561a12d1..abbf3621d 100644 --- a/letshelp-letsencrypt/docs/conf.py +++ b/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 ------------------------------------------------ diff --git a/letshelp-letsencrypt/docs/index.rst b/letshelp-letsencrypt/docs/index.rst index db806d874..6b67a2e1f 100644 --- a/letshelp-letsencrypt/docs/index.rst +++ b/letshelp-letsencrypt/docs/index.rst @@ -12,6 +12,11 @@ Contents: :maxdepth: 2 +.. toctree:: + :maxdepth: 1 + + api + Indices and tables ==================