X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=devel%2Fnmbug%2Fdoc%2Fconf.py;fp=devel%2Fnmbug%2Fdoc%2Fconf.py;h=29379d03bc407a0b10537bd9f1f65d0b0f40cfe6;hp=0000000000000000000000000000000000000000;hb=d6cbb24fcf6ad2a4306c0913b10b1f3c574bbcaa;hpb=399c857ebaeafb3bb68caaa659b87ba371e7426b diff --git a/devel/nmbug/doc/conf.py b/devel/nmbug/doc/conf.py new file mode 100644 index 00000000..29379d03 --- /dev/null +++ b/devel/nmbug/doc/conf.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- + +import os.path + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'notmuch' +authors = 'Carl Worth and many others' +copyright = '2009-2015, {0}'.format(authors) + +location = os.path.dirname(__file__) + +dirname = location +while True: + version_file = os.path.join(dirname, 'version') + if os.path.exists(version_file): + with open(version_file,'r') as f: + version = f.read().strip() + break + if dirname == '/': + raise ValueError( + 'no version file found in this directory or its ancestors') + dirname = os.path.dirname(dirname) + +# The full version, including alpha/beta/rc tags. +release = version + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). + +man_pages = [ + ('man1/notmuch-report.1', 'notmuch-report', + 'generate reports from notmuch queries', [authors], 1), + ('man5/notmuch-report.json.5', 'notmuch-report.json', + 'configure notmuch-report', [authors], 5), +] + +# If true, show URL addresses after external links. +#man_show_urls = False + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +# If true, do not generate a @detailmenu in the "Top" node's menu. +texinfo_no_detailmenu = True + +texinfo_documents = [ + ('man1/notmuch-report.1', 'notmuch-report', + 'generate reports from notmuch queries', authors, 'notmuch-report', + 'generate reports from notmuch queries', 'Miscellaneous'), + ('man5/notmuch-report.json.5', 'notmuch-report.json', + 'configure notmuch-report', authors, 'notmuch-report.json', + 'configure notmuch-report', 'Miscellaneous'), +]