From 0956e61c7c8653218bcaa46087d4508fc795feaa Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Wed, 30 Nov 2016 10:47:10 -0800 Subject: [PATCH] Remove the sphinxcontrib.programout [docs]dependency (#3830) - By making a static text file at release time, and including that instead. --- acme/docs/conf.py | 1 - acme/docs/jws-help.txt | 8 ++++++++ acme/docs/man/jws.rst | 2 +- acme/setup.py | 1 - docs/api/log.rst | 5 ----- docs/conf.py | 1 - setup.py | 1 - tools/release.sh | 1 + 8 files changed, 10 insertions(+), 10 deletions(-) create mode 100644 acme/docs/jws-help.txt delete mode 100644 docs/api/log.rst diff --git a/acme/docs/conf.py b/acme/docs/conf.py index 55f5eee3f..dea23a8ca 100644 --- a/acme/docs/conf.py +++ b/acme/docs/conf.py @@ -39,7 +39,6 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', - 'sphinxcontrib.programoutput', ] autodoc_member_order = 'bysource' diff --git a/acme/docs/jws-help.txt b/acme/docs/jws-help.txt new file mode 100644 index 000000000..34cf5ce23 --- /dev/null +++ b/acme/docs/jws-help.txt @@ -0,0 +1,8 @@ +usage: jws [-h] [--compact] {sign,verify} ... + +positional arguments: + {sign,verify} + +optional arguments: + -h, --help show this help message and exit + --compact diff --git a/acme/docs/man/jws.rst b/acme/docs/man/jws.rst index fb3121a96..d7ff8f405 100644 --- a/acme/docs/man/jws.rst +++ b/acme/docs/man/jws.rst @@ -1 +1 @@ -.. program-output:: jws --help all +.. literalinclude:: ../jws-help.txt diff --git a/acme/setup.py b/acme/setup.py index 2b32f7e28..895889c7c 100644 --- a/acme/setup.py +++ b/acme/setup.py @@ -49,7 +49,6 @@ dev_extras = [ docs_extras = [ 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags 'sphinx_rtd_theme', - 'sphinxcontrib-programoutput', ] diff --git a/docs/api/log.rst b/docs/api/log.rst deleted file mode 100644 index 41311de90..000000000 --- a/docs/api/log.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`certbot.log` ----------------------- - -.. automodule:: certbot.log - :members: diff --git a/docs/conf.py b/docs/conf.py index e387e1eae..7b3f2026c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -45,7 +45,6 @@ extensions = [ 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'repoze.sphinx.autointerface', - 'sphinxcontrib.programoutput', ] autodoc_member_order = 'bysource' diff --git a/setup.py b/setup.py index 90c98d469..46dbdac81 100644 --- a/setup.py +++ b/setup.py @@ -79,7 +79,6 @@ docs_extras = [ 'repoze.sphinx.autointerface', 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags 'sphinx_rtd_theme', - 'sphinxcontrib-programoutput', ] setup( diff --git a/tools/release.sh b/tools/release.sh index c4bb61f2f..be306d8e0 100755 --- a/tools/release.sh +++ b/tools/release.sh @@ -147,6 +147,7 @@ cd ~- # get a snapshot of the CLI help for the docs certbot --help all > docs/cli-help.txt +jws --help > acme/docs/jws-help.txt cd .. # freeze before installing anything else, so that we know end-user KGS