conf.py 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. # -*- coding: utf-8 -*-
  2. #
  3. # core-admin documentation build configuration file, created by
  4. # sphinx-quickstart on Thu Nov 13 15:02:15 2014.
  5. #
  6. # This file is execfile()d with the current directory set to its containing dir.
  7. #
  8. # Note that not all possible configuration values are present in this
  9. # autogenerated file.
  10. #
  11. # All configuration values have a default; values that are commented out
  12. # serve to show the default.
  13. import os
  14. import subprocess
  15. import sys
  16. import time
  17. # If extensions (or modules to document with autodoc) are in another directory,
  18. # add these directories to sys.path here. If the directory is relative to the
  19. # documentation root, use os.path.abspath to make it absolute, like shown here.
  20. sys.path.insert(0, os.path.abspath('../'))
  21. sys.path.insert(1, os.path.abspath('../test-packages'))
  22. # -- General configuration -----------------------------------------------------
  23. # If your documentation needs a minimal Sphinx version, state it here.
  24. #needs_sphinx = '1.0'
  25. # Add any Sphinx extension module names here, as strings. They can be extensions
  26. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  27. extensions = [
  28. 'sphinx.ext.autodoc',
  29. 'sphinx.ext.autosummary',
  30. 'sphinx.ext.coverage',
  31. 'sphinx.ext.doctest',
  32. 'sphinx.ext.graphviz',
  33. 'sphinx.ext.inheritance_diagram',
  34. 'sphinx.ext.intersphinx',
  35. 'sphinx.ext.todo',
  36. 'sphinx.ext.viewcode',
  37. 'qubes.dochelpers',
  38. ]
  39. # Add any paths that contain templates here, relative to this directory.
  40. templates_path = ['_templates']
  41. # The suffix of source filenames.
  42. source_suffix = '.rst'
  43. # The encoding of source files.
  44. source_encoding = 'utf-8'
  45. # The master toctree document.
  46. master_doc = 'index'
  47. # General information about the project.
  48. project = u'core-admin'
  49. copyright = u'2010-{}, Invisible Things Lab'.format(time.strftime('%Y'))
  50. # The version info for the project you're documenting, acts as replacement for
  51. # |version| and |release|, also used in various other places throughout the
  52. # built documents.
  53. #
  54. # The short X.Y version.
  55. version = open('../version').read().strip()
  56. # The full version, including alpha/beta/rc tags.
  57. try:
  58. release = subprocess.check_output(['git', 'describe', '--long', '--dirty']).strip().decode()
  59. except:
  60. release = "1"
  61. # The language for content autogenerated by Sphinx. Refer to documentation
  62. # for a list of supported languages.
  63. #language = None
  64. # There are two options for replacing |today|: either, you set today to some
  65. # non-false value, then it is used:
  66. #today = ''
  67. # Else, today_fmt is used as the format for a strftime call.
  68. today_fmt = '%d.%m.%Y'
  69. # List of patterns, relative to source directory, that match files and
  70. # directories to ignore when looking for source files.
  71. exclude_patterns = ['_build']
  72. # The reST default role (used for this markup: `text`) to use for all documents.
  73. #default_role = None
  74. # If true, '()' will be appended to :func: etc. cross-reference text.
  75. add_function_parentheses = True
  76. # If true, the current module name will be prepended to all description
  77. # unit titles (such as .. function::).
  78. #add_module_names = True
  79. # If true, sectionauthor and moduleauthor directives will be shown in the
  80. # output. They are ignored by default.
  81. #show_authors = False
  82. # The name of the Pygments (syntax highlighting) style to use.
  83. pygments_style = 'sphinx'
  84. # A list of ignored prefixes for module index sorting.
  85. #modindex_common_prefix = []
  86. autodoc_member_order = 'groupwise'
  87. # -- Options for HTML output ---------------------------------------------------
  88. # The theme to use for HTML and HTML Help pages. See the documentation for
  89. # a list of builtin themes.
  90. #html_theme = 'default'
  91. html_theme = 'nature'
  92. # Theme options are theme-specific and customize the look and feel of a theme
  93. # further. For a list of options available for each theme, see the
  94. # documentation.
  95. html_theme_options = {
  96. # 'collapsiblesidebar': True,
  97. }
  98. # Add any paths that contain custom themes here, relative to this directory.
  99. #html_theme_path = []
  100. # The name for this set of Sphinx documents. If None, it defaults to
  101. # "<project> v<release> documentation".
  102. #html_title = None
  103. # A shorter title for the navigation bar. Default is the same as html_title.
  104. #html_short_title = None
  105. # The name of an image file (relative to this directory) to place at the top
  106. # of the sidebar.
  107. #html_logo = None
  108. # The name of an image file (within the static path) to use as favicon of the
  109. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  110. # pixels large.
  111. #html_favicon = None
  112. # Add any paths that contain custom static files (such as style sheets) here,
  113. # relative to this directory. They are copied after the builtin static files,
  114. # so a file named "default.css" will overwrite the builtin "default.css".
  115. html_static_path = ['_static']
  116. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  117. # using the given strftime format.
  118. html_last_updated_fmt = '%d.%m.%Y'
  119. # If true, SmartyPants will be used to convert quotes and dashes to
  120. # typographically correct entities.
  121. #html_use_smartypants = True
  122. # Custom sidebar templates, maps document names to template names.
  123. #html_sidebars = {}
  124. # Additional templates that should be rendered to pages, maps page names to
  125. # template names.
  126. #html_additional_pages = {}
  127. # If false, no module index is generated.
  128. #html_domain_indices = True
  129. # If false, no index is generated.
  130. #html_use_index = True
  131. # If true, the index is split into individual pages for each letter.
  132. #html_split_index = False
  133. # If true, links to the reST sources are added to the pages.
  134. #html_show_sourcelink = True
  135. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  136. #html_show_sphinx = True
  137. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  138. #html_show_copyright = True
  139. # If true, an OpenSearch description file will be output, and all pages will
  140. # contain a <link> tag referring to it. The value of this option must be the
  141. # base URL from which the finished HTML is served.
  142. #html_use_opensearch = ''
  143. # This is the file name suffix for HTML files (e.g. ".xhtml").
  144. #html_file_suffix = None
  145. # html links do not work with svg!
  146. graphviz_output_format = 'png'
  147. # Output file base name for HTML help builder.
  148. htmlhelp_basename = 'core-admin-doc'
  149. # -- Options for LaTeX output --------------------------------------------------
  150. latex_elements = {
  151. # The paper size ('letterpaper' or 'a4paper').
  152. #'papersize': 'letterpaper',
  153. # The font size ('10pt', '11pt' or '12pt').
  154. #'pointsize': '10pt',
  155. # Additional stuff for the LaTeX preamble.
  156. #'preamble': '',
  157. }
  158. # Grouping the document tree into LaTeX files. List of tuples
  159. # (source start file, target name, title, author, documentclass [howto/manual]).
  160. latex_documents = [
  161. ('index', 'core-admin.tex', u'core-admin Documentation',
  162. u'Invisible Things Lab', 'manual'),
  163. ]
  164. # The name of an image file (relative to this directory) to place at the top of
  165. # the title page.
  166. #latex_logo = None
  167. # For "manual" documents, if this is true, then toplevel headings are parts,
  168. # not chapters.
  169. #latex_use_parts = False
  170. # If true, show page references after internal links.
  171. #latex_show_pagerefs = False
  172. # If true, show URL addresses after external links.
  173. #latex_show_urls = False
  174. # Documents to append as an appendix to all manuals.
  175. #latex_appendices = []
  176. # If false, no module index is generated.
  177. #latex_domain_indices = True
  178. # -- Options for manual page output --------------------------------------------
  179. # One entry per manual page. List of tuples
  180. # (source start file, name, description, authors, manual section).
  181. # authors should be empty and authors should be specified in each man page,
  182. # because html builder will omit them
  183. _man_pages_author = []
  184. man_pages = [
  185. ('manpages/qubesd-query', 'qubesd-query',
  186. u'Low-level qubesd interrogation tool', _man_pages_author, 1),
  187. ('manpages/qrexec-policy-graph', 'qrexec-policy-graph',
  188. u'Graph qrexec policy', _man_pages_author, 1),
  189. ]
  190. if os.path.exists('sandbox.rst'):
  191. man_pages.append(('sandbox', 'sandbox',
  192. u'Sandbox manpage', 'Sandbox Author', 1))
  193. # If true, show URL addresses after external links.
  194. #man_show_urls = False
  195. # -- Options for Texinfo output ------------------------------------------------
  196. # Grouping the document tree into Texinfo files. List of tuples
  197. # (source start file, target name, title, author,
  198. # dir menu entry, description, category)
  199. texinfo_documents = [
  200. ('index', 'core-admin', u'core-admin Documentation',
  201. u'Invisible Things Lab', 'core-admin', 'One line description of project.',
  202. 'Miscellaneous'),
  203. ]
  204. # Documents to append as an appendix to all manuals.
  205. #texinfo_appendices = []
  206. # If false, no module index is generated.
  207. #texinfo_domain_indices = True
  208. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  209. #texinfo_show_urls = 'footnote'
  210. # Example configuration for intersphinx: refer to the Python standard library.
  211. intersphinx_mapping = {
  212. 'python': ('http://docs.python.org/', None)}