From 2893b25db1d1b5631c98a6d99cd290bccc2284d0 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Tue, 23 Dec 2014 10:59:33 +0000 Subject: [PATCH] Update API docs --- docs/api/client/apache.rst | 23 +++++++++++++++++++++++ docs/api/client/apache_configurator.rst | 5 ----- docs/api/client/challenge_util.rst | 5 +++++ docs/api/client/nginx_configurator.rst | 5 ----- docs/api/client/revoker.rst | 5 +++++ letsencrypt/client/apache/obj.py | 2 +- 6 files changed, 34 insertions(+), 11 deletions(-) create mode 100644 docs/api/client/apache.rst delete mode 100644 docs/api/client/apache_configurator.rst create mode 100644 docs/api/client/challenge_util.rst delete mode 100644 docs/api/client/nginx_configurator.rst create mode 100644 docs/api/client/revoker.rst diff --git a/docs/api/client/apache.rst b/docs/api/client/apache.rst new file mode 100644 index 000000000..dfa1edad6 --- /dev/null +++ b/docs/api/client/apache.rst @@ -0,0 +1,23 @@ +:mod:`letsencrypt.client.apache` +-------------------------------- + +.. automodule:: letsencrypt.client.apache + :members: + +:mod:`letsencrypt.client.apache.configurator` +============================================= + +.. automodule:: letsencrypt.client.apache.configurator + :members: + +:mod:`letsencrypt.client.apache.obj` +==================================== + +.. automodule:: letsencrypt.client.apache.obj + :members: + +:mod:`letsencrypt.client.apache.parser` +======================================= + +.. automodule:: letsencrypt.client.apache.parser + :members: diff --git a/docs/api/client/apache_configurator.rst b/docs/api/client/apache_configurator.rst deleted file mode 100644 index 76818e05a..000000000 --- a/docs/api/client/apache_configurator.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`letsencrypt.client.apache_configurator` ---------------------------------------------- - -.. automodule:: letsencrypt.client.apache_configurator - :members: diff --git a/docs/api/client/challenge_util.rst b/docs/api/client/challenge_util.rst new file mode 100644 index 000000000..3866230a5 --- /dev/null +++ b/docs/api/client/challenge_util.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.challenge_util` +---------------------------------------- + +.. automodule:: letsencrypt.client.challenge_util + :members: diff --git a/docs/api/client/nginx_configurator.rst b/docs/api/client/nginx_configurator.rst deleted file mode 100644 index efcef3ffe..000000000 --- a/docs/api/client/nginx_configurator.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`letsencrypt.client.nginx_configurator` --------------------------------------------- - -.. automodule:: letsencrypt.client.nginx_configurator - :members: diff --git a/docs/api/client/revoker.rst b/docs/api/client/revoker.rst new file mode 100644 index 000000000..e0a7db533 --- /dev/null +++ b/docs/api/client/revoker.rst @@ -0,0 +1,5 @@ +:mod:`letsencrypt.client.revoker` +--------------------------------- + +.. automodule:: letsencrypt.client.revoker + :members: diff --git a/letsencrypt/client/apache/obj.py b/letsencrypt/client/apache/obj.py index c4a481acd..df2f36ec4 100644 --- a/letsencrypt/client/apache/obj.py +++ b/letsencrypt/client/apache/obj.py @@ -5,7 +5,7 @@ class Addr(object): """Represents an Apache VirtualHost address. :param str addr: addr part of vhost address - :param str port: port number or *, or "" + :param str port: port number or \*, or "" """ def __init__(self, tup):