Merge pull request #705 from kuba/manpages

Add basic manpages for all binaries (fixes #700).
This commit is contained in:
James Kasten
2015-08-26 13:37:00 -04:00
5 changed files with 11 additions and 1 deletions
+7 -1
View File
@@ -54,6 +54,7 @@ extensions = [
'sphinx.ext.coverage', 'sphinx.ext.coverage',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'repoze.sphinx.autointerface', 'repoze.sphinx.autointerface',
'sphinxcontrib.programoutput',
] ]
autodoc_member_order = 'bysource' autodoc_member_order = 'bysource'
@@ -283,7 +284,12 @@ latex_documents = [
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'letsencrypt', u'Let\'s Encrypt Documentation', ('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. # If true, show URL addresses after external links.
+1
View File
@@ -0,0 +1 @@
.. program-output:: jws --help all
+1
View File
@@ -0,0 +1 @@
.. program-output:: letsencrypt-renewer --help
+1
View File
@@ -0,0 +1 @@
.. program-output:: letsencrypt --help all
+1
View File
@@ -60,6 +60,7 @@ docs_extras = [
'repoze.sphinx.autointerface', 'repoze.sphinx.autointerface',
'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags
'sphinx_rtd_theme', 'sphinx_rtd_theme',
'sphinxcontrib-programoutput',
] ]
testing_extras = [ testing_extras = [