A configuration organization tool.
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.

conf.py 5.1KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. # -*- coding: utf-8 -*-
  2. #
  3. # Configuration file for the Sphinx documentation builder.
  4. #
  5. # This file does only contain a selection of the most common options. For a
  6. # full list see the documentation:
  7. # http://www.sphinx-doc.org/en/master/config
  8. # -- Path setup --------------------------------------------------------------
  9. # If extensions (or modules to document with autodoc) are in another directory,
  10. # add these directories to sys.path here. If the directory is relative to the
  11. # documentation root, use os.path.abspath to make it absolute, like shown here.
  12. #
  13. # import os
  14. # import sys
  15. # sys.path.insert(0, os.path.abspath('.'))
  16. # -- Project information -----------------------------------------------------
  17. project = 'pegleg'
  18. copyright = '2018, Pegleg Authors'
  19. author = 'Pegleg Authors'
  20. # The short X.Y version
  21. version = ''
  22. # The full version, including alpha/beta/rc tags
  23. release = ''
  24. # -- General configuration ---------------------------------------------------
  25. # If your documentation needs a minimal Sphinx version, state it here.
  26. #
  27. # needs_sphinx = '1.0'
  28. # Add any Sphinx extension module names here, as strings. They can be
  29. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  30. # ones.
  31. extensions = [
  32. 'reno.sphinxext'
  33. ]
  34. # Add any paths that contain templates here, relative to this directory.
  35. templates_path = ['_templates']
  36. # The suffix(es) of source filenames.
  37. # You can specify multiple suffix as a list of string:
  38. #
  39. # source_suffix = ['.rst', '.md']
  40. source_suffix = '.rst'
  41. # The master toctree document.
  42. master_doc = 'index'
  43. # The language for content autogenerated by Sphinx. Refer to documentation
  44. # for a list of supported languages.
  45. #
  46. # This is also used if you do content translation via gettext catalogs.
  47. # Usually you set "language" from the command line for these cases.
  48. language = None
  49. # List of patterns, relative to source directory, that match files and
  50. # directories to ignore when looking for source files.
  51. # This pattern also affects html_static_path and html_extra_path.
  52. exclude_patterns = []
  53. # The name of the Pygments (syntax highlighting) style to use.
  54. pygments_style = None
  55. # -- Options for HTML output -------------------------------------------------
  56. # The theme to use for HTML and HTML Help pages. See the documentation for
  57. # a list of builtin themes.
  58. #
  59. html_theme = 'alabaster'
  60. # Theme options are theme-specific and customize the look and feel of a theme
  61. # further. For a list of options available for each theme, see the
  62. # documentation.
  63. #
  64. # html_theme_options = {}
  65. # Add any paths that contain custom static files (such as style sheets) here,
  66. # relative to this directory. They are copied after the builtin static files,
  67. # so a file named "default.css" will overwrite the builtin "default.css".
  68. html_static_path = ['_static']
  69. # Custom sidebar templates, must be a dictionary that maps document names
  70. # to template names.
  71. #
  72. # The default sidebars (for documents that don't match any pattern) are
  73. # defined by theme itself. Builtin themes are using these templates by
  74. # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
  75. # 'searchbox.html']``.
  76. #
  77. # html_sidebars = {}
  78. # -- Options for HTMLHelp output ---------------------------------------------
  79. # Output file base name for HTML help builder.
  80. htmlhelp_basename = 'AirshipPeglegdoc'
  81. # -- Options for LaTeX output ------------------------------------------------
  82. latex_elements = {
  83. # The paper size ('letterpaper' or 'a4paper').
  84. #
  85. # 'papersize': 'letterpaper',
  86. # The font size ('10pt', '11pt' or '12pt').
  87. #
  88. # 'pointsize': '10pt',
  89. # Additional stuff for the LaTeX preamble.
  90. #
  91. # 'preamble': '',
  92. # Latex figure (float) alignment
  93. #
  94. # 'figure_align': 'htbp',
  95. }
  96. # Grouping the document tree into LaTeX files. List of tuples
  97. # (source start file, target name, title,
  98. # author, documentclass [howto, manual, or own class]).
  99. latex_documents = [
  100. (master_doc, 'AirshipPegleg.tex', 'Airship Pegleg Documentation',
  101. 'Airship Authors', 'manual'),
  102. ]
  103. # -- Options for manual page output ------------------------------------------
  104. # One entry per manual page. List of tuples
  105. # (source start file, name, description, authors, manual section).
  106. man_pages = [
  107. (master_doc, 'airshippegleg', 'Airship Pegleg Documentation',
  108. [author], 1)
  109. ]
  110. # -- Options for Texinfo output ----------------------------------------------
  111. # Grouping the document tree into Texinfo files. List of tuples
  112. # (source start file, target name, title, author,
  113. # dir menu entry, description, category)
  114. texinfo_documents = [
  115. (master_doc, 'AirshipPegleg', 'Airship Pegleg Documentation',
  116. author, 'AirshipPegleg', 'One line description of project.',
  117. 'Miscellaneous'),
  118. ]
  119. # -- Options for Epub output -------------------------------------------------
  120. # Bibliographic Dublin Core info.
  121. epub_title = project
  122. # The unique identifier of the text. This can be a ISBN number
  123. # or the project homepage.
  124. #
  125. # epub_identifier = ''
  126. # A unique identification for the text.
  127. #
  128. # epub_uid = ''
  129. # A list of files that should not be packed into the epub file.
  130. epub_exclude_files = ['search.html']