Devuan deployment of britney2
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

173 lines
5.1 KiB

  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. #
  4. # britney2 documentation build configuration file, created by
  5. # sphinx-quickstart on Sat Dec 2 12:34:27 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. # Add .. so sphinx can find the britney2 modules.
  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 = ['sphinx.ext.autodoc',
  31. 'sphinx.ext.doctest',
  32. 'sphinx.ext.todo',
  33. 'sphinx.ext.coverage',
  34. 'sphinx.ext.viewcode']
  35. # Add any paths that contain templates here, relative to this directory.
  36. templates_path = ['_templates']
  37. # The suffix(es) of source filenames.
  38. # You can specify multiple suffix as a list of string:
  39. #
  40. # source_suffix = ['.rst', '.md']
  41. source_suffix = '.rst'
  42. # The master toctree document.
  43. master_doc = 'index'
  44. # General information about the project.
  45. project = 'britney2'
  46. copyright = '2017, Niels Thykier and others'
  47. author = 'Niels Thykier'
  48. # The version info for the project you're documenting, acts as replacement for
  49. # |version| and |release|, also used in various other places throughout the
  50. # built documents.
  51. #
  52. # The short X.Y version.
  53. version = ''
  54. # The full version, including alpha/beta/rc tags.
  55. release = ''
  56. # The language for content autogenerated by Sphinx. Refer to documentation
  57. # for a list of supported languages.
  58. #
  59. # This is also used if you do content translation via gettext catalogs.
  60. # Usually you set "language" from the command line for these cases.
  61. language = None
  62. # List of patterns, relative to source directory, that match files and
  63. # directories to ignore when looking for source files.
  64. # This patterns also effect to html_static_path and html_extra_path
  65. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  66. # The name of the Pygments (syntax highlighting) style to use.
  67. pygments_style = 'sphinx'
  68. # If true, `todo` and `todoList` produce output, else they produce nothing.
  69. todo_include_todos = True
  70. # -- Options for HTML output ----------------------------------------------
  71. # The theme to use for HTML and HTML Help pages. See the documentation for
  72. # a list of builtin themes.
  73. #
  74. html_theme = 'classic'
  75. # Theme options are theme-specific and customize the look and feel of a theme
  76. # further. For a list of options available for each theme, see the
  77. # documentation.
  78. #
  79. # html_theme_options = {}
  80. # Add any paths that contain custom static files (such as style sheets) here,
  81. # relative to this directory. They are copied after the builtin static files,
  82. # so a file named "default.css" will overwrite the builtin "default.css".
  83. #html_static_path = ['_static']
  84. # Custom sidebar templates, must be a dictionary that maps document names
  85. # to template names.
  86. #
  87. # This is required for the alabaster theme
  88. # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
  89. html_sidebars = {
  90. '**': [
  91. 'relations.html', # needs 'show_related': True theme option to display
  92. 'searchbox.html',
  93. ]
  94. }
  95. # -- Options for HTMLHelp output ------------------------------------------
  96. # Output file base name for HTML help builder.
  97. htmlhelp_basename = 'britney2doc'
  98. # -- Options for LaTeX output ---------------------------------------------
  99. latex_elements = {
  100. # The paper size ('letterpaper' or 'a4paper').
  101. #
  102. # 'papersize': 'letterpaper',
  103. # The font size ('10pt', '11pt' or '12pt').
  104. #
  105. # 'pointsize': '10pt',
  106. # Additional stuff for the LaTeX preamble.
  107. #
  108. # 'preamble': '',
  109. # Latex figure (float) alignment
  110. #
  111. # 'figure_align': 'htbp',
  112. }
  113. # Grouping the document tree into LaTeX files. List of tuples
  114. # (source start file, target name, title,
  115. # author, documentclass [howto, manual, or own class]).
  116. latex_documents = [
  117. (master_doc, 'britney2.tex', 'britney2 Documentation',
  118. 'Niels Thykier', 'manual'),
  119. ]
  120. # -- Options for manual page output ---------------------------------------
  121. # One entry per manual page. List of tuples
  122. # (source start file, name, description, authors, manual section).
  123. man_pages = [
  124. (master_doc, 'britney2', 'britney2 Documentation',
  125. [author], 1)
  126. ]
  127. # -- Options for Texinfo output -------------------------------------------
  128. # Grouping the document tree into Texinfo files. List of tuples
  129. # (source start file, target name, title, author,
  130. # dir menu entry, description, category)
  131. texinfo_documents = [
  132. (master_doc, 'britney2', 'britney2 Documentation',
  133. author, 'britney2', 'One line description of project.',
  134. 'Miscellaneous'),
  135. ]