diff --git a/docs/api/client/plugins/nginx.rst b/docs/api/client/plugins/nginx.rst new file mode 100644 index 000000000..cd64846bf --- /dev/null +++ b/docs/api/client/plugins/nginx.rst @@ -0,0 +1,35 @@ +:mod:`letsencrypt.client.plugins.nginx` +---------------------------------------- + +.. automodule:: letsencrypt.client.plugins.nginx + :members: + +:mod:`letsencrypt.client.plugins.nginx.configurator` +===================================================== + +.. automodule:: letsencrypt.client.plugins.nginx.configurator + :members: + +:mod:`letsencrypt.client.plugins.nginx.dvsni` +============================================== + +.. automodule:: letsencrypt.client.plugins.nginx.dvsni + :members: + +:mod:`letsencrypt.client.plugins.nginx.obj` +============================================ + +.. automodule:: letsencrypt.client.plugins.nginx.obj + :members: + +:mod:`letsencrypt.client.plugins.nginx.parser` +=============================================== + +.. automodule:: letsencrypt.client.plugins.nginx.parser + :members: + +:mod:`letsencrypt.client.plugins.nginx.nginxparser` +==================================================== + +.. automodule:: letsencrypt.client.plugins.nginx.nginxparser + :members: diff --git a/letsencrypt/client/plugins/nginx/configurator.py b/letsencrypt/client/plugins/nginx/configurator.py index ebafe8286..95ebeab3a 100644 --- a/letsencrypt/client/plugins/nginx/configurator.py +++ b/letsencrypt/client/plugins/nginx/configurator.py @@ -26,6 +26,8 @@ class NginxConfigurator(object): # pylint: disable=too-many-instance-attributes,too-many-public-methods """Nginx configurator. + .. warning:: This plugin is a stub, does not support DVSNI yet! + .. todo:: Add proper support for comments in the config. Currently, config files modified by the configurator will lose all their comments.