diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2012-01-13 10:32:21 +0000 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-01-13 10:32:21 +0000 |
| commit | 1314551eb78dc9a96ee9b6148016faf05ec723ad (patch) | |
| tree | be98c9a8777e58b36b16c2abddc2f62184ba1f59 /docs | |
| parent | 45b5c6fe1a5bd48761fd3c25ecfa5c46baae0dcb (diff) | |
manpage generation via sphinx
this tunes the "make man" command in docs/user
to produce two manual pages, one for section 1
and one for the configuration file (section 5)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/user/source/conf.py | 6 | ||||
| -rw-r--r-- | docs/user/source/manpage.rst | 19 |
2 files changed, 23 insertions, 2 deletions
diff --git a/docs/user/source/conf.py b/docs/user/source/conf.py index b9babda3..134c5aca 100644 --- a/docs/user/source/conf.py +++ b/docs/user/source/conf.py @@ -211,8 +211,10 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'alot', u'alot Documentation', - [u'Patrick Totzke'], 1) + ('manpage', 'alot', u'mail user agent for the notmuch mail system', + [u'Patrick Totzke'], 1), + ('configuration', 'alot.rc', u'CONF', + [u'Patrick Totzke'], 5) ] diff --git a/docs/user/source/manpage.rst b/docs/user/source/manpage.rst new file mode 100644 index 00000000..009cfbf3 --- /dev/null +++ b/docs/user/source/manpage.rst @@ -0,0 +1,19 @@ +.. alot documentation master file, created by + sphinx-quickstart on Tue Jan 10 16:45:54 2012. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Manpage +======= + +Synopsis +-------- + +.. include:: usage/synopsis.rst + +Description +----------- + +.. include:: description.rst + +#.. include:: usage.rst |