conf.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326
  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. release = subprocess.check_output(['git', 'describe', '--long', '--dirty']).strip()
  58. # The language for content autogenerated by Sphinx. Refer to documentation
  59. # for a list of supported languages.
  60. #language = None
  61. # There are two options for replacing |today|: either, you set today to some
  62. # non-false value, then it is used:
  63. #today = ''
  64. # Else, today_fmt is used as the format for a strftime call.
  65. today_fmt = '%d.%m.%Y'
  66. # List of patterns, relative to source directory, that match files and
  67. # directories to ignore when looking for source files.
  68. exclude_patterns = ['_build']
  69. # The reST default role (used for this markup: `text`) to use for all documents.
  70. #default_role = None
  71. # If true, '()' will be appended to :func: etc. cross-reference text.
  72. add_function_parentheses = True
  73. # If true, the current module name will be prepended to all description
  74. # unit titles (such as .. function::).
  75. #add_module_names = True
  76. # If true, sectionauthor and moduleauthor directives will be shown in the
  77. # output. They are ignored by default.
  78. #show_authors = False
  79. # The name of the Pygments (syntax highlighting) style to use.
  80. pygments_style = 'sphinx'
  81. # A list of ignored prefixes for module index sorting.
  82. #modindex_common_prefix = []
  83. autodoc_member_order = 'groupwise'
  84. # -- Options for HTML output ---------------------------------------------------
  85. # The theme to use for HTML and HTML Help pages. See the documentation for
  86. # a list of builtin themes.
  87. #html_theme = 'default'
  88. html_theme = 'nature'
  89. # Theme options are theme-specific and customize the look and feel of a theme
  90. # further. For a list of options available for each theme, see the
  91. # documentation.
  92. html_theme_options = {
  93. # 'collapsiblesidebar': True,
  94. }
  95. # Add any paths that contain custom themes here, relative to this directory.
  96. #html_theme_path = []
  97. # The name for this set of Sphinx documents. If None, it defaults to
  98. # "<project> v<release> documentation".
  99. #html_title = None
  100. # A shorter title for the navigation bar. Default is the same as html_title.
  101. #html_short_title = None
  102. # The name of an image file (relative to this directory) to place at the top
  103. # of the sidebar.
  104. #html_logo = None
  105. # The name of an image file (within the static path) to use as favicon of the
  106. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  107. # pixels large.
  108. #html_favicon = None
  109. # Add any paths that contain custom static files (such as style sheets) here,
  110. # relative to this directory. They are copied after the builtin static files,
  111. # so a file named "default.css" will overwrite the builtin "default.css".
  112. html_static_path = ['_static']
  113. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  114. # using the given strftime format.
  115. html_last_updated_fmt = '%d.%m.%Y'
  116. # If true, SmartyPants will be used to convert quotes and dashes to
  117. # typographically correct entities.
  118. #html_use_smartypants = True
  119. # Custom sidebar templates, maps document names to template names.
  120. #html_sidebars = {}
  121. # Additional templates that should be rendered to pages, maps page names to
  122. # template names.
  123. #html_additional_pages = {}
  124. # If false, no module index is generated.
  125. #html_domain_indices = True
  126. # If false, no index is generated.
  127. #html_use_index = True
  128. # If true, the index is split into individual pages for each letter.
  129. #html_split_index = False
  130. # If true, links to the reST sources are added to the pages.
  131. #html_show_sourcelink = True
  132. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  133. #html_show_sphinx = True
  134. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  135. #html_show_copyright = True
  136. # If true, an OpenSearch description file will be output, and all pages will
  137. # contain a <link> tag referring to it. The value of this option must be the
  138. # base URL from which the finished HTML is served.
  139. #html_use_opensearch = ''
  140. # This is the file name suffix for HTML files (e.g. ".xhtml").
  141. #html_file_suffix = None
  142. # html links do not work with svg!
  143. graphviz_output_format = 'png'
  144. # Output file base name for HTML help builder.
  145. htmlhelp_basename = 'core-admin-doc'
  146. # -- Options for LaTeX output --------------------------------------------------
  147. latex_elements = {
  148. # The paper size ('letterpaper' or 'a4paper').
  149. #'papersize': 'letterpaper',
  150. # The font size ('10pt', '11pt' or '12pt').
  151. #'pointsize': '10pt',
  152. # Additional stuff for the LaTeX preamble.
  153. #'preamble': '',
  154. }
  155. # Grouping the document tree into LaTeX files. List of tuples
  156. # (source start file, target name, title, author, documentclass [howto/manual]).
  157. latex_documents = [
  158. ('index', 'core-admin.tex', u'core-admin Documentation',
  159. u'Invisible Things Lab', 'manual'),
  160. ]
  161. # The name of an image file (relative to this directory) to place at the top of
  162. # the title page.
  163. #latex_logo = None
  164. # For "manual" documents, if this is true, then toplevel headings are parts,
  165. # not chapters.
  166. #latex_use_parts = False
  167. # If true, show page references after internal links.
  168. #latex_show_pagerefs = False
  169. # If true, show URL addresses after external links.
  170. #latex_show_urls = False
  171. # Documents to append as an appendix to all manuals.
  172. #latex_appendices = []
  173. # If false, no module index is generated.
  174. #latex_domain_indices = True
  175. # -- Options for manual page output --------------------------------------------
  176. # One entry per manual page. List of tuples
  177. # (source start file, name, description, authors, manual section).
  178. # authors should be empty and authors should be specified in each man page,
  179. # because html builder will omit them
  180. _man_pages_author = []
  181. man_pages = [
  182. ('manpages/qvm-add-appvm', 'qvm-add-appvm',
  183. u'Add an already installed appvm to the Qubes DB', _man_pages_author, 1),
  184. ('manpages/qvm-add-template', 'qvm-add-template',
  185. u'Adds an already installed template to the Qubes DB', _man_pages_author, 1),
  186. ('manpages/qvm-backup-restore', 'qvm-backup-restore',
  187. u'Restores Qubes VMs from backup', _man_pages_author, 1),
  188. ('manpages/qvm-backup', 'qvm-backup',
  189. u'Create backup of specified VMs', _man_pages_author, 1),
  190. ('manpages/qvm-block', 'qvm-block',
  191. u'Qubes volume and block device managment', _man_pages_author, 1),
  192. ('manpages/qvm-clone-template', 'qvm-clone-template',
  193. u'Clones an existing template by copying all its disk files', _man_pages_author, 1),
  194. ('manpages/qvm-clone', 'qvm-clone',
  195. u'Clones an existing VM by copying all its disk files', _man_pages_author, 1),
  196. ('manpages/qvm-create-default-dvm', 'qvm-create-default-dvm',
  197. u'Creates a default disposable VM', _man_pages_author, 1),
  198. ('manpages/qvm-create', 'qvm-create',
  199. u'Creates a new VM', _man_pages_author, 1),
  200. ('manpages/qvm-firewall', 'qvm-firewall',
  201. u'Qubes firewall configuration', _man_pages_author, 1),
  202. ('manpages/qvm-grow-private', 'qvm-grow-private',
  203. u'Increase private storage capacity of a specified VM', _man_pages_author, 1),
  204. ('manpages/qvm-kill', 'qvm-kill',
  205. u'Kill the specified VM', _man_pages_author, 1),
  206. ('manpages/qvm-ls', 'qvm-ls',
  207. u'List VMs and various information about them', _man_pages_author, 1),
  208. ('manpages/qvm-pci', 'qvm-pci',
  209. u'List/set VM PCI devices', _man_pages_author, 1),
  210. ('manpages/qvm-pool', 'qvm-pool',
  211. u'Manages Qubes pools and their options', _man_pages_author, 1),
  212. ('manpages/qvm-prefs', 'qvm-prefs',
  213. u'List/set various per-VM properties', _man_pages_author, 1),
  214. ('manpages/qvm-remove', 'qvm-remove',
  215. u'Remove a VM', _man_pages_author, 1),
  216. ('manpages/qvm-revert-template-changes', 'qvm-revert-template-changes',
  217. u'Revert changes to a template', _man_pages_author, 1),
  218. ('manpages/qvm-run', 'qvm-run',
  219. u'Run a command on a specified VM', _man_pages_author, 1),
  220. ('manpages/qvm-service', 'qvm-service',
  221. u'Manage (Qubes-specific) services started in VM', _man_pages_author, 1),
  222. ('manpages/qvm-shutdown', 'qvm-shutdown',
  223. u'Gracefully shut down a VM', _man_pages_author, 1),
  224. ('manpages/qvm-start', 'qvm-start',
  225. u'Start a specified VM', _man_pages_author, 1),
  226. ('manpages/qvm-template-commit', 'qvm-template-commit',
  227. u'Commit changes to a template', _man_pages_author, 1),
  228. ('manpages/qubes-prefs', 'qubes-prefs',
  229. u'Display system-wide Qubes settings', _man_pages_author, 1),
  230. ]
  231. if os.path.exists('sandbox.rst'):
  232. man_pages.append(('sandbox', 'sandbox',
  233. u'Sandbox manpage', 'Sandbox Author', 1))
  234. # If true, show URL addresses after external links.
  235. #man_show_urls = False
  236. # -- Options for Texinfo output ------------------------------------------------
  237. # Grouping the document tree into Texinfo files. List of tuples
  238. # (source start file, target name, title, author,
  239. # dir menu entry, description, category)
  240. texinfo_documents = [
  241. ('index', 'core-admin', u'core-admin Documentation',
  242. u'Invisible Things Lab', 'core-admin', 'One line description of project.',
  243. 'Miscellaneous'),
  244. ]
  245. # Documents to append as an appendix to all manuals.
  246. #texinfo_appendices = []
  247. # If false, no module index is generated.
  248. #texinfo_domain_indices = True
  249. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  250. #texinfo_show_urls = 'footnote'
  251. # Example configuration for intersphinx: refer to the Python standard library.
  252. intersphinx_mapping = {
  253. 'python': ('http://docs.python.org/', None)}