From 6f3b03db777c64bbb83dadb641d02bb491fa6935 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Sun, 10 May 2015 13:03:48 +0000 Subject: [PATCH] Fix doumentation for bundled packages --- docs/index.rst | 4 +--- docs/pkgs.rst | 14 ++++++++++++++ docs/{ => pkgs}/acme/index.rst | 0 docs/{ => pkgs}/acme/jose.rst | 0 docs/{ => pkgs}/letsencrypt_apache.rst | 0 docs/{ => pkgs}/letsencrypt_nginx.rst | 0 6 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 docs/pkgs.rst rename docs/{ => pkgs}/acme/index.rst (100%) rename docs/{ => pkgs}/acme/jose.rst (100%) rename docs/{ => pkgs}/letsencrypt_apache.rst (100%) rename docs/{ => pkgs}/letsencrypt_nginx.rst (100%) diff --git a/docs/index.rst b/docs/index.rst index 6bd5c06c9..b076b45c6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,14 +8,12 @@ Welcome to the Let's Encrypt client documentation! using contributing plugins - acme - letsencrypt_apache - letsencrypt_nginx .. toctree:: :maxdepth: 1 api + pkgs Indices and tables diff --git a/docs/pkgs.rst b/docs/pkgs.rst new file mode 100644 index 000000000..8119ffc7e --- /dev/null +++ b/docs/pkgs.rst @@ -0,0 +1,14 @@ +======== +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/lets-encrypt-preview/issues/358 + +.. toctree:: + :glob: + + pkgs/** diff --git a/docs/acme/index.rst b/docs/pkgs/acme/index.rst similarity index 100% rename from docs/acme/index.rst rename to docs/pkgs/acme/index.rst diff --git a/docs/acme/jose.rst b/docs/pkgs/acme/jose.rst similarity index 100% rename from docs/acme/jose.rst rename to docs/pkgs/acme/jose.rst diff --git a/docs/letsencrypt_apache.rst b/docs/pkgs/letsencrypt_apache.rst similarity index 100% rename from docs/letsencrypt_apache.rst rename to docs/pkgs/letsencrypt_apache.rst diff --git a/docs/letsencrypt_nginx.rst b/docs/pkgs/letsencrypt_nginx.rst similarity index 100% rename from docs/letsencrypt_nginx.rst rename to docs/pkgs/letsencrypt_nginx.rst