git.notmuchmail.org Git - notmuch/blob - devel/nmbug/doc/conf.py

   1 # -*- coding: utf-8 -*-
   2
   3 import os.path
   4
   5 # The suffix of source filenames.
   6 source_suffix = '.rst'
   7
   8 # The master toctree document.
   9 master_doc = 'index'
  10
  11 # General information about the project.
  12 project = 'notmuch'
  13 authors = 'Carl Worth and many others'
  14 copyright = '2009-2015, {0}'.format(authors)
  15
  16 location = os.path.dirname(__file__)
  17
  18 dirname = location
  19 while True:
  20     version_file = os.path.join(dirname, 'version')
  21     if os.path.exists(version_file):
  22         with open(version_file,'r') as f:
  23             version = f.read().strip()
  24             break
  25     if dirname == '/':
  26         raise ValueError(
  27             'no version file found in this directory or its ancestors')
  28     dirname = os.path.dirname(dirname)
  29
  30 # The full version, including alpha/beta/rc tags.
  31 release = version
  32
  33 # List of patterns, relative to source directory, that match files and
  34 # directories to ignore when looking for source files.
  35 exclude_patterns = ['_build']
  36
  37 # -- Options for manual page output ---------------------------------------
  38
  39 # One entry per manual page. List of tuples
  40 # (source start file, name, description, authors, manual section).
  41
  42 man_pages = [
  43     ('man1/notmuch-report.1', 'notmuch-report',
  44      'generate reports from notmuch queries', [authors], 1),
  45     ('man5/notmuch-report.json.5', 'notmuch-report.json',
  46      'configure notmuch-report', [authors], 5),
  47 ]
  48
  49 # If true, show URL addresses after external links.
  50 #man_show_urls = False
  51
  52 # -- Options for Texinfo output -------------------------------------------
  53
  54 # Grouping the document tree into Texinfo files. List of tuples
  55 # (source start file, target name, title, author,
  56 #  dir menu entry, description, category)
  57 # If true, do not generate a @detailmenu in the "Top" node's menu.
  58 texinfo_no_detailmenu = True
  59
  60 texinfo_documents = [
  61     ('man1/notmuch-report.1', 'notmuch-report',
  62      'generate reports from notmuch queries', authors, 'notmuch-report',
  63      'generate reports from notmuch queries', 'Miscellaneous'),
  64     ('man5/notmuch-report.json.5', 'notmuch-report.json',
  65      'configure notmuch-report', authors, 'notmuch-report.json',
  66      'configure notmuch-report', 'Miscellaneous'),
  67 ]