docs/conf.py

   1 #!/usr/bin/env python3
   2 # -*- coding: utf-8 -*-
   3
   4 import sphinx_rtd_theme
   5
   6 #
   7 # The Mesa 3D Graphics Library documentation build configuration file, created by
   8 # sphinx-quickstart on Wed Mar 29 14:08:51 2017.
   9 #
  10 # This file is execfile()d with the current directory set to its
  11 # containing dir.
  12 #
  13 # Note that not all possible configuration values are present in this
  14 # autogenerated file.
  15 #
  16 # All configuration values have a default; values that are commented out
  17 # serve to show the default.
  18
  19 # If extensions (or modules to document with autodoc) are in another directory,
  20 # add these directories to sys.path here. If the directory is relative to the
  21 # documentation root, use os.path.abspath to make it absolute, like shown here.
  22 #
  23 import os
  24 import sys
  25
  26 # If extensions (or modules to document with autodoc) are in another directory,
  27 # add these directories to sys.path here. If the directory is relative to the
  28 # documentation root, use os.path.abspath to make it absolute, like shown here.
  29 sys.path.append(os.path.abspath('_exts'))
  30
  31
  32 # -- General configuration ------------------------------------------------
  33
  34 # If your documentation needs a minimal Sphinx version, state it here.
  35 #
  36 # needs_sphinx = '1.0'
  37
  38 # Add any Sphinx extension module names here, as strings. They can be
  39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  40 # ones.
  41 extensions = ['sphinx.ext.graphviz', 'formatting', 'redirects']
  42
  43 # Add any paths that contain templates here, relative to this directory.
  44 templates_path = ['_templates']
  45
  46 # The suffix(es) of source filenames.
  47 # You can specify multiple suffix as a list of string:
  48 #
  49 # source_suffix = ['.rst', '.md']
  50 source_suffix = '.rst'
  51
  52 # The master toctree document.
  53 master_doc = 'index'
  54
  55 # General information about the project.
  56 project = 'The Mesa 3D Graphics Library'
  57 copyright = '1995-2018, Brian Paul'
  58 author = 'Brian Paul'
  59 html_show_copyright = False
  60
  61 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
  62
  63 # The version info for the project you're documenting, acts as replacement for
  64 # |version| and |release|, also used in various other places throughout the
  65 # built documents.
  66 #
  67 # The short X.Y version.
  68 version = 'latest'
  69 # The full version, including alpha/beta/rc tags.
  70 release = 'latest'
  71
  72 # The language for content autogenerated by Sphinx. Refer to documentation
  73 # for a list of supported languages.
  74 #
  75 # This is also used if you do content translation via gettext catalogs.
  76 # Usually you set "language" from the command line for these cases.
  77 language = None
  78
  79 # List of patterns, relative to source directory, that match files and
  80 # directories to ignore when looking for source files.
  81 # This patterns also effect to html_static_path and html_extra_path
  82 exclude_patterns = [ "contents.rst" ]
  83
  84 # The name of the Pygments (syntax highlighting) style to use.
  85 pygments_style = 'sphinx'
  86
  87 # If true, `todo` and `todoList` produce output, else they produce nothing.
  88 todo_include_todos = False
  89
  90 # Disable highlighting unless a language is specified, otherwise we'll get
  91 # python keywords highlit in literal blocks.
  92 highlight_language = "none"
  93
  94
  95 # -- Options for HTML output ----------------------------------------------
  96
  97 # The theme to use for HTML and HTML Help pages.  See the documentation for
  98 # a list of builtin themes.
  99 #
 100 html_theme = 'sphinx_rtd_theme'
 101
 102 html_favicon = "favicon.ico"
 103
 104 # Theme options are theme-specific and customize the look and feel of a theme
 105 # further.  For a list of options available for each theme, see the
 106 # documentation.
 107 #
 108 html_theme_options = {
 109   'display_version': False,
 110 }
 111
 112 html_copy_source = False
 113
 114 # Add any paths that contain custom static files (such as style sheets) here,
 115 # relative to this directory. They are copied after the builtin static files,
 116 # so a file named "default.css" will overwrite the builtin "default.css".
 117 html_static_path = []
 118
 119 html_extra_path = [
 120   '_extra/',
 121   'release-maintainers-keys.asc',
 122   'features.txt',
 123   'libGL.txt',
 124   'README.UVD',
 125   'README.VCE',
 126   'README.WIN32',
 127 ]
 128
 129
 130 # -- Options for HTMLHelp output ------------------------------------------
 131
 132 # Output file base name for HTML help builder.
 133 htmlhelp_basename = 'TheMesa3DGraphicsLibrarydoc'
 134
 135
 136 # -- Options for LaTeX output ---------------------------------------------
 137
 138 latex_elements = {
 139     # The paper size ('letterpaper' or 'a4paper').
 140     #
 141     # 'papersize': 'letterpaper',
 142
 143     # The font size ('10pt', '11pt' or '12pt').
 144     #
 145     # 'pointsize': '10pt',
 146
 147     # Additional stuff for the LaTeX preamble.
 148     #
 149     # 'preamble': '',
 150
 151     # Latex figure (float) alignment
 152     #
 153     # 'figure_align': 'htbp',
 154 }
 155
 156 # Grouping the document tree into LaTeX files. List of tuples
 157 # (source start file, target name, title,
 158 #  author, documentclass [howto, manual, or own class]).
 159 latex_documents = [
 160     (master_doc, 'TheMesa3DGraphicsLibrary.tex', 'The Mesa 3D Graphics Library Documentation',
 161      'Brian Paul', 'manual'),
 162 ]
 163
 164
 165 # -- Options for manual page output ---------------------------------------
 166
 167 # One entry per manual page. List of tuples
 168 # (source start file, name, description, authors, manual section).
 169 man_pages = [
 170     (master_doc, 'themesa3dgraphicslibrary', 'The Mesa 3D Graphics Library Documentation',
 171      [author], 1)
 172 ]
 173
 174
 175 # -- Options for Texinfo output -------------------------------------------
 176
 177 # Grouping the document tree into Texinfo files. List of tuples
 178 # (source start file, target name, title, author,
 179 #  dir menu entry, description, category)
 180 texinfo_documents = [
 181     (master_doc, 'TheMesa3DGraphicsLibrary', 'The Mesa 3D Graphics Library Documentation',
 182      author, 'TheMesa3DGraphicsLibrary', 'One line description of project.',
 183      'Miscellaneous'),
 184 ]
 185
 186 # -- Options for Graphviz -------------------------------------------------
 187
 188 graphviz_output_format = 'svg'