From 56b75e93cef29aff6716207996b01dbe057f4a64 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Sun, 30 Nov 2014 00:09:29 +0100 Subject: [PATCH] autodoc API documentation --- docs/api/client/CONFIG.rst | 5 +++++ docs/api/client/acme.rst | 5 +++++ docs/api/client/apache_configurator.rst | 5 +++++ docs/api/client/augeas_configurator.rst | 5 +++++ docs/api/client/challenge.rst | 5 +++++ docs/api/client/client.rst | 5 +++++ docs/api/client/configurator.rst | 5 +++++ docs/api/client/crypto_util.rst | 5 +++++ docs/api/client/display.rst | 5 +++++ docs/api/client/errors.rst | 5 +++++ docs/api/client/index.rst | 5 +++++ docs/api/client/interactive_challenge.rst | 5 +++++ docs/api/client/le_util.rst | 5 +++++ docs/api/client/logger.rst | 5 +++++ docs/api/client/nginx_configurator.rst | 5 +++++ docs/api/client/recovery_contact_challenge.rst | 5 +++++ docs/api/client/recovery_token_challenge.rst | 5 +++++ docs/api/client/validator.rst | 5 +++++ docs/index.rst | 6 ++++-- 19 files changed, 94 insertions(+), 2 deletions(-) create mode 100644 docs/api/client/CONFIG.rst create mode 100644 docs/api/client/acme.rst create mode 100644 docs/api/client/apache_configurator.rst create mode 100644 docs/api/client/augeas_configurator.rst create mode 100644 docs/api/client/challenge.rst create mode 100644 docs/api/client/client.rst create mode 100644 docs/api/client/configurator.rst create mode 100644 docs/api/client/crypto_util.rst create mode 100644 docs/api/client/display.rst create mode 100644 docs/api/client/errors.rst create mode 100644 docs/api/client/index.rst create mode 100644 docs/api/client/interactive_challenge.rst create mode 100644 docs/api/client/le_util.rst create mode 100644 docs/api/client/logger.rst create mode 100644 docs/api/client/nginx_configurator.rst create mode 100644 docs/api/client/recovery_contact_challenge.rst create mode 100644 docs/api/client/recovery_token_challenge.rst create mode 100644 docs/api/client/validator.rst diff --git a/docs/api/client/CONFIG.rst b/docs/api/client/CONFIG.rst new file mode 100644 index 000000000..9ed190768 --- /dev/null +++ b/docs/api/client/CONFIG.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.CONFIG` +-------------------------------- + +.. automodule:: letsencrypt.client.CONFIG + :members: diff --git a/docs/api/client/acme.rst b/docs/api/client/acme.rst new file mode 100644 index 000000000..7773fae04 --- /dev/null +++ b/docs/api/client/acme.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.acme` +------------------------------ + +.. automodule:: letsencrypt.client.acme + :members: diff --git a/docs/api/client/apache_configurator.rst b/docs/api/client/apache_configurator.rst new file mode 100644 index 000000000..76818e05a --- /dev/null +++ b/docs/api/client/apache_configurator.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.apache_configurator` +--------------------------------------------- + +.. automodule:: letsencrypt.client.apache_configurator + :members: diff --git a/docs/api/client/augeas_configurator.rst b/docs/api/client/augeas_configurator.rst new file mode 100644 index 000000000..6b8ca4d83 --- /dev/null +++ b/docs/api/client/augeas_configurator.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.augeas_configurator` +--------------------------------------------- + +.. automodule:: letsencrypt.client.augeas_configurator + :members: diff --git a/docs/api/client/challenge.rst b/docs/api/client/challenge.rst new file mode 100644 index 000000000..c46e1b053 --- /dev/null +++ b/docs/api/client/challenge.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.challenge` +----------------------------------- + +.. automodule:: letsencrypt.client.challenge + :members: diff --git a/docs/api/client/client.rst b/docs/api/client/client.rst new file mode 100644 index 000000000..ac68c2764 --- /dev/null +++ b/docs/api/client/client.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.client` +-------------------------------- + +.. automodule:: letsencrypt.client.client + :members: diff --git a/docs/api/client/configurator.rst b/docs/api/client/configurator.rst new file mode 100644 index 000000000..7331f35ec --- /dev/null +++ b/docs/api/client/configurator.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.configurator` +-------------------------------------- + +.. automodule:: letsencrypt.client.configurator + :members: diff --git a/docs/api/client/crypto_util.rst b/docs/api/client/crypto_util.rst new file mode 100644 index 000000000..1b47cd151 --- /dev/null +++ b/docs/api/client/crypto_util.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.crypto_util` +------------------------------------- + +.. automodule:: letsencrypt.client.crypto_util + :members: diff --git a/docs/api/client/display.rst b/docs/api/client/display.rst new file mode 100644 index 000000000..5dde8b66d --- /dev/null +++ b/docs/api/client/display.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.display` +--------------------------------- + +.. automodule:: letsencrypt.client.display + :members: diff --git a/docs/api/client/errors.rst b/docs/api/client/errors.rst new file mode 100644 index 000000000..40f0ae6c7 --- /dev/null +++ b/docs/api/client/errors.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.errors` +-------------------------------- + +.. automodule:: letsencrypt.client.errors + :members: diff --git a/docs/api/client/index.rst b/docs/api/client/index.rst new file mode 100644 index 000000000..7fe44df50 --- /dev/null +++ b/docs/api/client/index.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client` +------------------------- + +.. automodule:: letsencrypt.client + :members: diff --git a/docs/api/client/interactive_challenge.rst b/docs/api/client/interactive_challenge.rst new file mode 100644 index 000000000..38f14f115 --- /dev/null +++ b/docs/api/client/interactive_challenge.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.interactive_challenge` +----------------------------------------------- + +.. automodule:: letsencrypt.client.interactive_challenge + :members: diff --git a/docs/api/client/le_util.rst b/docs/api/client/le_util.rst new file mode 100644 index 000000000..537e90546 --- /dev/null +++ b/docs/api/client/le_util.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.le_util` +--------------------------------- + +.. automodule:: letsencrypt.client.le_util + :members: diff --git a/docs/api/client/logger.rst b/docs/api/client/logger.rst new file mode 100644 index 000000000..8225c306c --- /dev/null +++ b/docs/api/client/logger.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.logger` +-------------------------------- + +.. automodule:: letsencrypt.client.logger + :members: diff --git a/docs/api/client/nginx_configurator.rst b/docs/api/client/nginx_configurator.rst new file mode 100644 index 000000000..efcef3ffe --- /dev/null +++ b/docs/api/client/nginx_configurator.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.nginx_configurator` +-------------------------------------------- + +.. automodule:: letsencrypt.client.nginx_configurator + :members: diff --git a/docs/api/client/recovery_contact_challenge.rst b/docs/api/client/recovery_contact_challenge.rst new file mode 100644 index 000000000..3b6e12a0f --- /dev/null +++ b/docs/api/client/recovery_contact_challenge.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.recovery_contact_challenge` +---------------------------------------------------- + +.. automodule:: letsencrypt.client.recovery_contact_challenge + :members: diff --git a/docs/api/client/recovery_token_challenge.rst b/docs/api/client/recovery_token_challenge.rst new file mode 100644 index 000000000..68fbdc6e1 --- /dev/null +++ b/docs/api/client/recovery_token_challenge.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.recovery_token_challenge` +-------------------------------------------------- + +.. automodule:: letsencrypt.client.recovery_token_challenge + :members: diff --git a/docs/api/client/validator.rst b/docs/api/client/validator.rst new file mode 100644 index 000000000..7f990e2a4 --- /dev/null +++ b/docs/api/client/validator.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.validator` +----------------------------------- + +.. automodule:: letsencrypt.client.validator + :members: diff --git a/docs/index.rst b/docs/index.rst index 8b2941505..c636507df 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,11 +6,13 @@ Welcome to Let's Encrypt's documentation! ========================================= -Contents: +API documentation +----------------- .. toctree:: - :maxdepth: 2 + :glob: + api/** Indices and tables