conf.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. #
  4. # Qubes Admin client documentation build configuration file, created by
  5. # sphinx-quickstart on Thu May 11 19:00:43 2017.
  6. #
  7. # This file is execfile()d with the current directory set to its
  8. # containing dir.
  9. #
  10. # Note that not all possible configuration values are present in this
  11. # autogenerated file.
  12. #
  13. # All configuration values have a default; values that are commented out
  14. # serve to show the default.
  15. # If extensions (or modules to document with autodoc) are in another directory,
  16. # add these directories to sys.path here. If the directory is relative to the
  17. # documentation root, use os.path.abspath to make it absolute, like shown here.
  18. #
  19. import os
  20. import sys
  21. import subprocess
  22. sys.path.insert(0, os.path.abspath('..'))
  23. # -- General configuration ------------------------------------------------
  24. # If your documentation needs a minimal Sphinx version, state it here.
  25. #
  26. # needs_sphinx = '1.0'
  27. # Add any Sphinx extension module names here, as strings. They can be
  28. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  29. # ones.
  30. extensions = [
  31. 'sphinx.ext.autodoc',
  32. 'sphinx.ext.doctest',
  33. 'sphinx.ext.intersphinx',
  34. 'sphinx.ext.todo',
  35. 'sphinx.ext.coverage',
  36. 'sphinx.ext.viewcode',
  37. ]
  38. try:
  39. import qubesadmin.tools.dochelpers
  40. extensions.append('qubesadmin.tools.dochelpers')
  41. except ImportError:
  42. pass
  43. # Add any paths that contain templates here, relative to this directory.
  44. templates_path = ['_templates']
  45. # The suffix(es) of source filenames.
  46. # You can specify multiple suffix as a list of string:
  47. #
  48. # source_suffix = ['.rst', '.md']
  49. source_suffix = '.rst'
  50. # The encoding of source files.
  51. #
  52. # source_encoding = 'utf-8-sig'
  53. # The master toctree document.
  54. master_doc = 'index'
  55. # General information about the project.
  56. project = 'Qubes Admin client'
  57. copyright = '2017, Invisible Things Lab'
  58. author = 'Invisible Things Lab'
  59. # The version info for the project you're documenting, acts as replacement for
  60. # |version| and |release|, also used in various other places throughout the
  61. # built documents.
  62. #
  63. # The short X.Y version.
  64. version = open('../version').read().strip()
  65. # The full version, including alpha/beta/rc tags.
  66. release = subprocess.check_output(['git', 'describe', '--long', '--dirty']).strip().decode()
  67. # The language for content autogenerated by Sphinx. Refer to documentation
  68. # for a list of supported languages.
  69. #
  70. # This is also used if you do content translation via gettext catalogs.
  71. # Usually you set "language" from the command line for these cases.
  72. language = None
  73. # There are two options for replacing |today|: either, you set today to some
  74. # non-false value, then it is used:
  75. #
  76. # today = ''
  77. #
  78. # Else, today_fmt is used as the format for a strftime call.
  79. #
  80. # today_fmt = '%B %d, %Y'
  81. # List of patterns, relative to source directory, that match files and
  82. # directories to ignore when looking for source files.
  83. # This patterns also effect to html_static_path and html_extra_path
  84. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  85. # The reST default role (used for this markup: `text`) to use for all
  86. # documents.
  87. #
  88. # default_role = None
  89. # If true, '()' will be appended to :func: etc. cross-reference text.
  90. #
  91. add_function_parentheses = True
  92. # If true, the current module name will be prepended to all description
  93. # unit titles (such as .. function::).
  94. #
  95. # add_module_names = True
  96. # If true, sectionauthor and moduleauthor directives will be shown in the
  97. # output. They are ignored by default.
  98. #
  99. # show_authors = False
  100. # The name of the Pygments (syntax highlighting) style to use.
  101. pygments_style = 'sphinx'
  102. # A list of ignored prefixes for module index sorting.
  103. # modindex_common_prefix = []
  104. # If true, keep warnings as "system message" paragraphs in the built documents.
  105. # keep_warnings = False
  106. # If true, `todo` and `todoList` produce output, else they produce nothing.
  107. todo_include_todos = True
  108. # -- Options for HTML output ----------------------------------------------
  109. # The theme to use for HTML and HTML Help pages. See the documentation for
  110. # a list of builtin themes.
  111. #
  112. #html_theme = 'alabaster'
  113. html_theme = 'nature'
  114. # Theme options are theme-specific and customize the look and feel of a theme
  115. # further. For a list of options available for each theme, see the
  116. # documentation.
  117. #
  118. # html_theme_options = {}
  119. # Add any paths that contain custom themes here, relative to this directory.
  120. # html_theme_path = []
  121. # The name for this set of Sphinx documents.
  122. # "<project> v<release> documentation" by default.
  123. #
  124. # html_title = 'Qubes Admin client v4.0.0'
  125. # A shorter title for the navigation bar. Default is the same as html_title.
  126. #
  127. # html_short_title = None
  128. # The name of an image file (relative to this directory) to place at the top
  129. # of the sidebar.
  130. #
  131. # html_logo = None
  132. # The name of an image file (relative to this directory) to use as a favicon of
  133. # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  134. # pixels large.
  135. #
  136. # html_favicon = None
  137. # Add any paths that contain custom static files (such as style sheets) here,
  138. # relative to this directory. They are copied after the builtin static files,
  139. # so a file named "default.css" will overwrite the builtin "default.css".
  140. html_static_path = ['_static']
  141. # Add any extra paths that contain custom files (such as robots.txt or
  142. # .htaccess) here, relative to this directory. These files are copied
  143. # directly to the root of the documentation.
  144. #
  145. # html_extra_path = []
  146. # If not None, a 'Last updated on:' timestamp is inserted at every page
  147. # bottom, using the given strftime format.
  148. # The empty string is equivalent to '%b %d, %Y'.
  149. #
  150. # html_last_updated_fmt = None
  151. # If true, SmartyPants will be used to convert quotes and dashes to
  152. # typographically correct entities.
  153. #
  154. # html_use_smartypants = True
  155. # Custom sidebar templates, maps document names to template names.
  156. #
  157. # html_sidebars = {}
  158. # Additional templates that should be rendered to pages, maps page names to
  159. # template names.
  160. #
  161. # html_additional_pages = {}
  162. # If false, no module index is generated.
  163. #
  164. # html_domain_indices = True
  165. # If false, no index is generated.
  166. #
  167. # html_use_index = True
  168. # If true, the index is split into individual pages for each letter.
  169. #
  170. # html_split_index = False
  171. # If true, links to the reST sources are added to the pages.
  172. #
  173. # html_show_sourcelink = True
  174. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  175. #
  176. # html_show_sphinx = True
  177. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  178. #
  179. # html_show_copyright = True
  180. # If true, an OpenSearch description file will be output, and all pages will
  181. # contain a <link> tag referring to it. The value of this option must be the
  182. # base URL from which the finished HTML is served.
  183. #
  184. # html_use_opensearch = ''
  185. # This is the file name suffix for HTML files (e.g. ".xhtml").
  186. # html_file_suffix = None
  187. # Language to be used for generating the HTML full-text search index.
  188. # Sphinx supports the following languages:
  189. # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
  190. # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
  191. #
  192. # html_search_language = 'en'
  193. # A dictionary with options for the search language support, empty by default.
  194. # 'ja' uses this config value.
  195. # 'zh' user can custom change `jieba` dictionary path.
  196. #
  197. # html_search_options = {'type': 'default'}
  198. # The name of a javascript file (relative to the configuration directory) that
  199. # implements a search results scorer. If empty, the default will be used.
  200. #
  201. # html_search_scorer = 'scorer.js'
  202. # Output file base name for HTML help builder.
  203. htmlhelp_basename = 'QubesAdminclientdoc'
  204. # -- Options for LaTeX output ---------------------------------------------
  205. latex_elements = {
  206. # The paper size ('letterpaper' or 'a4paper').
  207. #
  208. # 'papersize': 'letterpaper',
  209. # The font size ('10pt', '11pt' or '12pt').
  210. #
  211. # 'pointsize': '10pt',
  212. # Additional stuff for the LaTeX preamble.
  213. #
  214. # 'preamble': '',
  215. # Latex figure (float) alignment
  216. #
  217. # 'figure_align': 'htbp',
  218. }
  219. # Grouping the document tree into LaTeX files. List of tuples
  220. # (source start file, target name, title,
  221. # author, documentclass [howto, manual, or own class]).
  222. latex_documents = [
  223. (master_doc, 'QubesAdminclient.tex', 'Qubes Admin client Documentation',
  224. 'Invisible Things Lab', 'manual'),
  225. ]
  226. # The name of an image file (relative to this directory) to place at the top of
  227. # the title page.
  228. #
  229. # latex_logo = None
  230. # For "manual" documents, if this is true, then toplevel headings are parts,
  231. # not chapters.
  232. #
  233. # latex_use_parts = False
  234. # If true, show page references after internal links.
  235. #
  236. # latex_show_pagerefs = False
  237. # If true, show URL addresses after external links.
  238. #
  239. # latex_show_urls = False
  240. # Documents to append as an appendix to all manuals.
  241. #
  242. # latex_appendices = []
  243. # It false, will not define \strong, \code, itleref, \crossref ... but only
  244. # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
  245. # packages.
  246. #
  247. # latex_keep_old_macro_names = True
  248. # If false, no module index is generated.
  249. #
  250. # latex_domain_indices = True
  251. # -- Options for manual page output ---------------------------------------
  252. # authors should be empty and authors should be specified in each man page,
  253. # because html builder will omit them
  254. _man_pages_author = []
  255. # One entry per manual page. List of tuples
  256. # (source start file, name, description, authors, manual section).
  257. man_pages = [
  258. ('manpages/qvm-backup-restore', 'qvm-backup-restore',
  259. u'Restores Qubes VMs from backup', _man_pages_author, 1),
  260. ('manpages/qvm-backup', 'qvm-backup',
  261. u'Create backup of specified qubes', _man_pages_author, 1),
  262. ('manpages/qvm-check', 'qvm-check',
  263. u'Check existence/state of a qube', _man_pages_author, 1),
  264. ('manpages/qvm-clone', 'qvm-clone',
  265. u'Clones an existing qube by copying all its disk files', _man_pages_author, 1),
  266. ('manpages/qvm-create', 'qvm-create',
  267. u'Creates a new qube', _man_pages_author, 1),
  268. ('manpages/qvm-device', 'qvm-device',
  269. u'List/set VM devices', _man_pages_author, 1),
  270. ('manpages/qvm-features', 'qvm-features',
  271. u'Manage VM features', _man_pages_author, 1),
  272. ('manpages/qvm-firewall', 'qvm-firewall',
  273. u'Qubes firewall configuration', _man_pages_author, 1),
  274. ('manpages/qvm-kill', 'qvm-kill',
  275. u'Kill the specified qube', _man_pages_author, 1),
  276. ('manpages/qvm-ls', 'qvm-ls',
  277. u'List VMs and various information about them', _man_pages_author, 1),
  278. ('manpages/qvm-pause', 'qvm-pause',
  279. u'Pause a specified qube(s)', _man_pages_author, 1),
  280. ('manpages/qvm-pool', 'qvm-pool',
  281. u'Manages Qubes pools and their options', _man_pages_author, 1),
  282. ('manpages/qvm-prefs', 'qvm-prefs',
  283. u'List/set various per-VM properties', _man_pages_author, 1),
  284. ('manpages/qvm-remove', 'qvm-remove',
  285. u'Remove a VM', _man_pages_author, 1),
  286. ('manpages/qvm-run', 'qvm-run',
  287. u'Run a command on a specified VM', _man_pages_author, 1),
  288. ('manpages/qvm-service', 'qvm-service',
  289. u'Manage (Qubes-specific) services started in VM', _man_pages_author, 1),
  290. ('manpages/qvm-shutdown', 'qvm-shutdown',
  291. u'Gracefully shut down a qube', _man_pages_author, 1),
  292. ('manpages/qvm-start-gui', 'qvm-start-gui',
  293. u'Start GUI daemon for qubes', _man_pages_author, 1),
  294. ('manpages/qvm-start', 'qvm-start',
  295. u'Start a specified qube', _man_pages_author, 1),
  296. ('manpages/qvm-tags', 'qvm-tags',
  297. u'Manage tags on a qube', _man_pages_author, 1),
  298. ('manpages/qvm-unpause', 'qvm-unpause',
  299. u'Pause a qube', _man_pages_author, 1),
  300. ('manpages/qvm-volume', 'qvm-volume',
  301. u'Manage storage volumes of a qube', _man_pages_author, 1),
  302. ('manpages/qubes-prefs', 'qubes-prefs',
  303. u'Display system-wide Qubes settings', _man_pages_author, 1),
  304. ]
  305. # If true, show URL addresses after external links.
  306. #
  307. # man_show_urls = False
  308. # -- Options for Texinfo output -------------------------------------------
  309. # Grouping the document tree into Texinfo files. List of tuples
  310. # (source start file, target name, title, author,
  311. # dir menu entry, description, category)
  312. texinfo_documents = [
  313. (master_doc, 'QubesAdminclient', 'Qubes Admin client Documentation',
  314. author, 'QubesAdminclient', 'One line description of project.',
  315. 'Miscellaneous'),
  316. ]
  317. # Documents to append as an appendix to all manuals.
  318. #
  319. # texinfo_appendices = []
  320. # If false, no module index is generated.
  321. #
  322. # texinfo_domain_indices = True
  323. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  324. #
  325. # texinfo_show_urls = 'footnote'
  326. # If true, do not generate a @detailmenu in the "Top" node's menu.
  327. #
  328. # texinfo_no_detailmenu = False
  329. # Example configuration for intersphinx: refer to the Python standard library.
  330. intersphinx_mapping = {
  331. 'python': ('https://docs.python.org/', None),
  332. 'qubes': ('https://dev.qubes-os.org/projects/qubes-core-admin/en/latest', None),
  333. }