From ec35828b9addc105c01c88d0dcb5b7b9d1279d73 Mon Sep 17 00:00:00 2001 From: jonasbn Date: Sun, 2 Jul 2017 00:12:16 +0200 Subject: [PATCH 1/5] Added missing rst files after doing an inspection of the file structure --- docs/api/cert_manager.rst | 5 +++++ docs/api/cli.rst | 5 +++++ docs/api/eff.rst | 5 +++++ docs/api/error_handler.rst | 5 +++++ docs/api/hooks.rst | 5 +++++ docs/api/lock.rst | 5 +++++ docs/api/log.rst | 5 +++++ docs/api/main.rst | 5 +++++ docs/api/notify.rst | 5 +++++ docs/api/ocsp.rst | 5 +++++ docs/api/plugins/common_test.rst | 5 +++++ docs/api/plugins/disco_test.rst | 5 +++++ docs/api/plugins/dns_common_lexicon_test.rst | 5 +++++ docs/api/plugins/dns_common_test.rst | 5 +++++ docs/api/plugins/dns_test_common.rst | 5 +++++ docs/api/plugins/dns_test_common_lexicon.rst | 5 +++++ docs/api/plugins/manual_test.rst | 5 +++++ docs/api/plugins/null.rst | 5 +++++ docs/api/plugins/null_test.rst | 5 +++++ docs/api/plugins/selection.rst | 5 +++++ docs/api/plugins/selection_test.rst | 5 +++++ docs/api/plugins/standalone_test.rst | 5 +++++ docs/api/plugins/webroot_test.rst | 5 +++++ docs/api/renewal.rst | 5 +++++ 24 files changed, 120 insertions(+) create mode 100644 docs/api/cert_manager.rst create mode 100644 docs/api/cli.rst create mode 100644 docs/api/eff.rst create mode 100644 docs/api/error_handler.rst create mode 100644 docs/api/hooks.rst create mode 100644 docs/api/lock.rst create mode 100644 docs/api/log.rst create mode 100644 docs/api/main.rst create mode 100644 docs/api/notify.rst create mode 100644 docs/api/ocsp.rst create mode 100644 docs/api/plugins/common_test.rst create mode 100644 docs/api/plugins/disco_test.rst create mode 100644 docs/api/plugins/dns_common_lexicon_test.rst create mode 100644 docs/api/plugins/dns_common_test.rst create mode 100644 docs/api/plugins/dns_test_common.rst create mode 100644 docs/api/plugins/dns_test_common_lexicon.rst create mode 100644 docs/api/plugins/manual_test.rst create mode 100644 docs/api/plugins/null.rst create mode 100644 docs/api/plugins/null_test.rst create mode 100644 docs/api/plugins/selection.rst create mode 100644 docs/api/plugins/selection_test.rst create mode 100644 docs/api/plugins/standalone_test.rst create mode 100644 docs/api/plugins/webroot_test.rst create mode 100644 docs/api/renewal.rst diff --git a/docs/api/cert_manager.rst b/docs/api/cert_manager.rst new file mode 100644 index 000000000..c8c86f8b9 --- /dev/null +++ b/docs/api/cert_manager.rst @@ -0,0 +1,5 @@ +:mod:`certbot.cert_manager` +------------------------------- + +.. automodule:: certbot.cert_manager + :members: diff --git a/docs/api/cli.rst b/docs/api/cli.rst new file mode 100644 index 000000000..91be86758 --- /dev/null +++ b/docs/api/cli.rst @@ -0,0 +1,5 @@ +:mod:`certbot.cli` +---------------------- + +.. automodule:: certbot.cli + :members: diff --git a/docs/api/eff.rst b/docs/api/eff.rst new file mode 100644 index 000000000..2924b256d --- /dev/null +++ b/docs/api/eff.rst @@ -0,0 +1,5 @@ +:mod:`certbot.eff` +---------------------- + +.. automodule:: certbot.eff + :members: diff --git a/docs/api/error_handler.rst b/docs/api/error_handler.rst new file mode 100644 index 000000000..f1306177d --- /dev/null +++ b/docs/api/error_handler.rst @@ -0,0 +1,5 @@ +:mod:`certbot.error_handler` +-------------------------------- + +.. automodule:: certbot.error_handler + :members: diff --git a/docs/api/hooks.rst b/docs/api/hooks.rst new file mode 100644 index 000000000..140fbf284 --- /dev/null +++ b/docs/api/hooks.rst @@ -0,0 +1,5 @@ +:mod:`certbot.hooks` +------------------------ + +.. automodule:: certbot.hooks + :members: diff --git a/docs/api/lock.rst b/docs/api/lock.rst new file mode 100644 index 000000000..6dcbf9589 --- /dev/null +++ b/docs/api/lock.rst @@ -0,0 +1,5 @@ +:mod:`certbot.lock` +----------------------- + +.. automodule:: certbot.lock + :members: diff --git a/docs/api/log.rst b/docs/api/log.rst new file mode 100644 index 000000000..0b1cbd09c --- /dev/null +++ b/docs/api/log.rst @@ -0,0 +1,5 @@ +:mod:`certbot.log` +---------------------- + +.. automodule:: log.eff + :members: diff --git a/docs/api/main.rst b/docs/api/main.rst new file mode 100644 index 000000000..a555bab01 --- /dev/null +++ b/docs/api/main.rst @@ -0,0 +1,5 @@ +:mod:`certbot.main` +----------------------- + +.. automodule:: certbot.main + :members: diff --git a/docs/api/notify.rst b/docs/api/notify.rst new file mode 100644 index 000000000..fa042b2d2 --- /dev/null +++ b/docs/api/notify.rst @@ -0,0 +1,5 @@ +:mod:`certbot.notify` +------------------------- + +.. automodule:: certbot.notify + :members: diff --git a/docs/api/ocsp.rst b/docs/api/ocsp.rst new file mode 100644 index 000000000..7044f4052 --- /dev/null +++ b/docs/api/ocsp.rst @@ -0,0 +1,5 @@ +:mod:`certbot.ocsp` +----------------------- + +.. automodule:: certbot.ocsp + :members: diff --git a/docs/api/plugins/common_test.rst b/docs/api/plugins/common_test.rst new file mode 100644 index 000000000..f01e78e7b --- /dev/null +++ b/docs/api/plugins/common_test.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.common_test` +-------------------------------------- + +.. automodule:: certbot.plugins.common_test + :members: diff --git a/docs/api/plugins/disco_test.rst b/docs/api/plugins/disco_test.rst new file mode 100644 index 000000000..6b9b73c6b --- /dev/null +++ b/docs/api/plugins/disco_test.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.disco_test` +------------------------------------- + +.. automodule:: certbot.plugins.disco_test + :members: diff --git a/docs/api/plugins/dns_common_lexicon_test.rst b/docs/api/plugins/dns_common_lexicon_test.rst new file mode 100644 index 000000000..22ca71c66 --- /dev/null +++ b/docs/api/plugins/dns_common_lexicon_test.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.dns_common_lexicon_test` +-------------------------------------------------- + +.. automodule:: certbot.plugins.dns_common_lexicon_test + :members: diff --git a/docs/api/plugins/dns_common_test.rst b/docs/api/plugins/dns_common_test.rst new file mode 100644 index 000000000..c7c82fe14 --- /dev/null +++ b/docs/api/plugins/dns_common_test.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.dns_common_test` +------------------------------------------ + +.. automodule:: certbot.plugins.dns_common_test + :members: diff --git a/docs/api/plugins/dns_test_common.rst b/docs/api/plugins/dns_test_common.rst new file mode 100644 index 000000000..a02226a25 --- /dev/null +++ b/docs/api/plugins/dns_test_common.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.dns_test_common` +------------------------------------------ + +.. automodule:: certbot.plugins.dns_test_common + :members: diff --git a/docs/api/plugins/dns_test_common_lexicon.rst b/docs/api/plugins/dns_test_common_lexicon.rst new file mode 100644 index 000000000..e58d56cf2 --- /dev/null +++ b/docs/api/plugins/dns_test_common_lexicon.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.dns_test_common_lexicon` +-------------------------------------------------- + +.. automodule:: certbot.plugins.dns_test_common_lexicon + :members: diff --git a/docs/api/plugins/manual_test.rst b/docs/api/plugins/manual_test.rst new file mode 100644 index 000000000..b9d405d00 --- /dev/null +++ b/docs/api/plugins/manual_test.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.manual_test` +-------------------------------------- + +.. automodule:: certbot.plugins.manual_test + :members: diff --git a/docs/api/plugins/null.rst b/docs/api/plugins/null.rst new file mode 100644 index 000000000..97df40987 --- /dev/null +++ b/docs/api/plugins/null.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.null` +------------------------------- + +.. automodule:: certbot.plugins.null + :members: diff --git a/docs/api/plugins/null_test.rst b/docs/api/plugins/null_test.rst new file mode 100644 index 000000000..4a8e1efb3 --- /dev/null +++ b/docs/api/plugins/null_test.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.null_test` +------------------------------------ + +.. automodule:: certbot.plugins.null_test + :members: diff --git a/docs/api/plugins/selection.rst b/docs/api/plugins/selection.rst new file mode 100644 index 000000000..6211bf9c0 --- /dev/null +++ b/docs/api/plugins/selection.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.selection` +------------------------------------ + +.. automodule:: certbot.plugins.selection + :members: diff --git a/docs/api/plugins/selection_test.rst b/docs/api/plugins/selection_test.rst new file mode 100644 index 000000000..59c380c60 --- /dev/null +++ b/docs/api/plugins/selection_test.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.selection_test` +----------------------------------------- + +.. automodule:: certbot.plugins.selection_test + :members: diff --git a/docs/api/plugins/standalone_test.rst b/docs/api/plugins/standalone_test.rst new file mode 100644 index 000000000..21fd8eff5 --- /dev/null +++ b/docs/api/plugins/standalone_test.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.standalone_test` +------------------------------------------ + +.. automodule:: certbot.plugins.standalone_test + :members: diff --git a/docs/api/plugins/webroot_test.rst b/docs/api/plugins/webroot_test.rst new file mode 100644 index 000000000..893ea3067 --- /dev/null +++ b/docs/api/plugins/webroot_test.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.webroot_test` +--------------------------------------- + +.. automodule:: certbot.plugins.webroot_test + :members: diff --git a/docs/api/renewal.rst b/docs/api/renewal.rst new file mode 100644 index 000000000..58557351f --- /dev/null +++ b/docs/api/renewal.rst @@ -0,0 +1,5 @@ +:mod:`certbot.renewal` +-------------------------- + +.. automodule:: certbot.renewal + :members: From d118acf5248d95709ccb390a6a7ecf781e099857 Mon Sep 17 00:00:00 2001 From: jonasbn Date: Sun, 2 Jul 2017 00:16:15 +0200 Subject: [PATCH 2/5] Correction to module name --- docs/api/log.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/log.rst b/docs/api/log.rst index 0b1cbd09c..41311de90 100644 --- a/docs/api/log.rst +++ b/docs/api/log.rst @@ -1,5 +1,5 @@ :mod:`certbot.log` ---------------------- -.. automodule:: log.eff +.. automodule:: certbot.log :members: From 054873034c04ee3730a396f21523f5e125408ef4 Mon Sep 17 00:00:00 2001 From: jonasbn Date: Sun, 2 Jul 2017 00:31:58 +0200 Subject: [PATCH 3/5] Added missed rst file --- docs/api/plugins/util_test.rst | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/api/plugins/util_test.rst diff --git a/docs/api/plugins/util_test.rst b/docs/api/plugins/util_test.rst new file mode 100644 index 000000000..cce425a38 --- /dev/null +++ b/docs/api/plugins/util_test.rst @@ -0,0 +1,5 @@ +:mod:`certbot.plugins.util_test` +------------------------------------ + +.. automodule:: certbot.plugins.util_test + :members: From 72c480ef18d73bbb4e8a99e71d4d2415dd4b3960 Mon Sep 17 00:00:00 2001 From: jonasbn Date: Tue, 4 Jul 2017 23:52:24 +0200 Subject: [PATCH 4/5] Removed files with test in name after review comment from @ynasser --- docs/api/plugins/common_test.rst | 5 ----- docs/api/plugins/disco_test.rst | 5 ----- docs/api/plugins/dns_common_lexicon_test.rst | 5 ----- docs/api/plugins/dns_common_test.rst | 5 ----- docs/api/plugins/dns_test_common.rst | 5 ----- docs/api/plugins/dns_test_common_lexicon.rst | 5 ----- docs/api/plugins/manual_test.rst | 5 ----- docs/api/plugins/null_test.rst | 5 ----- docs/api/plugins/selection_test.rst | 5 ----- docs/api/plugins/standalone_test.rst | 5 ----- docs/api/plugins/util_test.rst | 5 ----- docs/api/plugins/webroot_test.rst | 5 ----- 12 files changed, 60 deletions(-) delete mode 100644 docs/api/plugins/common_test.rst delete mode 100644 docs/api/plugins/disco_test.rst delete mode 100644 docs/api/plugins/dns_common_lexicon_test.rst delete mode 100644 docs/api/plugins/dns_common_test.rst delete mode 100644 docs/api/plugins/dns_test_common.rst delete mode 100644 docs/api/plugins/dns_test_common_lexicon.rst delete mode 100644 docs/api/plugins/manual_test.rst delete mode 100644 docs/api/plugins/null_test.rst delete mode 100644 docs/api/plugins/selection_test.rst delete mode 100644 docs/api/plugins/standalone_test.rst delete mode 100644 docs/api/plugins/util_test.rst delete mode 100644 docs/api/plugins/webroot_test.rst diff --git a/docs/api/plugins/common_test.rst b/docs/api/plugins/common_test.rst deleted file mode 100644 index f01e78e7b..000000000 --- a/docs/api/plugins/common_test.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.common_test` --------------------------------------- - -.. automodule:: certbot.plugins.common_test - :members: diff --git a/docs/api/plugins/disco_test.rst b/docs/api/plugins/disco_test.rst deleted file mode 100644 index 6b9b73c6b..000000000 --- a/docs/api/plugins/disco_test.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.disco_test` -------------------------------------- - -.. automodule:: certbot.plugins.disco_test - :members: diff --git a/docs/api/plugins/dns_common_lexicon_test.rst b/docs/api/plugins/dns_common_lexicon_test.rst deleted file mode 100644 index 22ca71c66..000000000 --- a/docs/api/plugins/dns_common_lexicon_test.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.dns_common_lexicon_test` --------------------------------------------------- - -.. automodule:: certbot.plugins.dns_common_lexicon_test - :members: diff --git a/docs/api/plugins/dns_common_test.rst b/docs/api/plugins/dns_common_test.rst deleted file mode 100644 index c7c82fe14..000000000 --- a/docs/api/plugins/dns_common_test.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.dns_common_test` ------------------------------------------- - -.. automodule:: certbot.plugins.dns_common_test - :members: diff --git a/docs/api/plugins/dns_test_common.rst b/docs/api/plugins/dns_test_common.rst deleted file mode 100644 index a02226a25..000000000 --- a/docs/api/plugins/dns_test_common.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.dns_test_common` ------------------------------------------- - -.. automodule:: certbot.plugins.dns_test_common - :members: diff --git a/docs/api/plugins/dns_test_common_lexicon.rst b/docs/api/plugins/dns_test_common_lexicon.rst deleted file mode 100644 index e58d56cf2..000000000 --- a/docs/api/plugins/dns_test_common_lexicon.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.dns_test_common_lexicon` --------------------------------------------------- - -.. automodule:: certbot.plugins.dns_test_common_lexicon - :members: diff --git a/docs/api/plugins/manual_test.rst b/docs/api/plugins/manual_test.rst deleted file mode 100644 index b9d405d00..000000000 --- a/docs/api/plugins/manual_test.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.manual_test` --------------------------------------- - -.. automodule:: certbot.plugins.manual_test - :members: diff --git a/docs/api/plugins/null_test.rst b/docs/api/plugins/null_test.rst deleted file mode 100644 index 4a8e1efb3..000000000 --- a/docs/api/plugins/null_test.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.null_test` ------------------------------------- - -.. automodule:: certbot.plugins.null_test - :members: diff --git a/docs/api/plugins/selection_test.rst b/docs/api/plugins/selection_test.rst deleted file mode 100644 index 59c380c60..000000000 --- a/docs/api/plugins/selection_test.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.selection_test` ------------------------------------------ - -.. automodule:: certbot.plugins.selection_test - :members: diff --git a/docs/api/plugins/standalone_test.rst b/docs/api/plugins/standalone_test.rst deleted file mode 100644 index 21fd8eff5..000000000 --- a/docs/api/plugins/standalone_test.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.standalone_test` ------------------------------------------- - -.. automodule:: certbot.plugins.standalone_test - :members: diff --git a/docs/api/plugins/util_test.rst b/docs/api/plugins/util_test.rst deleted file mode 100644 index cce425a38..000000000 --- a/docs/api/plugins/util_test.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.util_test` ------------------------------------- - -.. automodule:: certbot.plugins.util_test - :members: diff --git a/docs/api/plugins/webroot_test.rst b/docs/api/plugins/webroot_test.rst deleted file mode 100644 index 893ea3067..000000000 --- a/docs/api/plugins/webroot_test.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.webroot_test` ---------------------------------------- - -.. automodule:: certbot.plugins.webroot_test - :members: From 7ed2e91cc781cb0b55df35c2fdd5df00d1f5ac68 Mon Sep 17 00:00:00 2001 From: jonasbn Date: Fri, 14 Jul 2017 12:52:25 +0200 Subject: [PATCH 5/5] Removed null.rst as by request --- docs/api/plugins/null.rst | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 docs/api/plugins/null.rst diff --git a/docs/api/plugins/null.rst b/docs/api/plugins/null.rst deleted file mode 100644 index 97df40987..000000000 --- a/docs/api/plugins/null.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.plugins.null` -------------------------------- - -.. automodule:: certbot.plugins.null - :members: