From 2e90ecf1b0b8b87a31e1ad0d1d5703e2e314b209 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Sat, 22 Aug 2015 14:11:46 +0000 Subject: [PATCH] Add basic manpages for all binaries (fixes #700). --- docs/conf.py | 8 +++++++- docs/man/jws.rst | 1 + docs/man/letsencrypt-renewer.rst | 1 + docs/man/letsencrypt.rst | 1 + setup.py | 1 + 5 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 docs/man/jws.rst create mode 100644 docs/man/letsencrypt-renewer.rst create mode 100644 docs/man/letsencrypt.rst diff --git a/docs/conf.py b/docs/conf.py index 50359ba4e..2b4b2cd43 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -54,6 +54,7 @@ extensions = [ 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'repoze.sphinx.autointerface', + 'sphinxcontrib.programoutput', ] autodoc_member_order = 'bysource' @@ -283,7 +284,12 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'letsencrypt', u'Let\'s Encrypt Documentation', - [u'Let\'s Encrypt Project'], 1) + [project], 7), + ('man/letsencrypt', 'letsencrypt', u'letsencrypt script documentation', + [project], 1), + ('man/letsencrypt-renewer', 'letsencrypt-renewer', + u'letsencrypt-renewer script documentation', [project], 1), + ('man/jws', 'jws', u'jws script documentation', [project], 1), ] # If true, show URL addresses after external links. diff --git a/docs/man/jws.rst b/docs/man/jws.rst new file mode 100644 index 000000000..fb3121a96 --- /dev/null +++ b/docs/man/jws.rst @@ -0,0 +1 @@ +.. program-output:: jws --help all diff --git a/docs/man/letsencrypt-renewer.rst b/docs/man/letsencrypt-renewer.rst new file mode 100644 index 000000000..8fd232fa8 --- /dev/null +++ b/docs/man/letsencrypt-renewer.rst @@ -0,0 +1 @@ +.. program-output:: letsencrypt-renewer --help diff --git a/docs/man/letsencrypt.rst b/docs/man/letsencrypt.rst new file mode 100644 index 000000000..30f33c890 --- /dev/null +++ b/docs/man/letsencrypt.rst @@ -0,0 +1 @@ +.. program-output:: letsencrypt --help all diff --git a/setup.py b/setup.py index a40303e50..f816c6c56 100644 --- a/setup.py +++ b/setup.py @@ -60,6 +60,7 @@ docs_extras = [ 'repoze.sphinx.autointerface', 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags 'sphinx_rtd_theme', + 'sphinxcontrib-programoutput', ] testing_extras = [