2 # -*- coding: utf-8 -*-
4 import sphinx_rtd_theme
7 # The Mesa 3D Graphics Library documentation build configuration file, created by
8 # sphinx-quickstart on Wed Mar 29 14:08:51 2017.
10 # This file is execfile()d with the current directory set to its
13 # Note that not all possible configuration values are present in this
16 # All configuration values have a default; values that are commented out
17 # serve to show the default.
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.
25 # sys.path.insert(0, os.path.abspath('.'))
28 # -- General configuration ------------------------------------------------
30 # If your documentation needs a minimal Sphinx version, state it here.
32 # needs_sphinx = '1.0'
34 # Add any Sphinx extension module names here, as strings. They can be
35 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39 # Add any paths that contain templates here, relative to this directory.
40 templates_path
= ['_templates']
42 # The suffix(es) of source filenames.
43 # You can specify multiple suffix as a list of string:
45 # source_suffix = ['.rst', '.md']
46 source_suffix
= '.rst'
48 # The master toctree document.
51 # General information about the project.
52 project
= 'The Mesa 3D Graphics Library'
53 copyright
= '1995-2018, Brian Paul'
55 html_show_copyright
= False
57 html_theme_path
= [sphinx_rtd_theme
.get_html_theme_path()]
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
63 # The short X.Y version.
65 # The full version, including alpha/beta/rc tags.
68 # The language for content autogenerated by Sphinx. Refer to documentation
69 # for a list of supported languages.
71 # This is also used if you do content translation via gettext catalogs.
72 # Usually you set "language" from the command line for these cases.
75 # List of patterns, relative to source directory, that match files and
76 # directories to ignore when looking for source files.
77 # This patterns also effect to html_static_path and html_extra_path
78 exclude_patterns
= [ "contents.rst" ]
80 # The name of the Pygments (syntax highlighting) style to use.
81 pygments_style
= 'sphinx'
83 # If true, `todo` and `todoList` produce output, else they produce nothing.
84 todo_include_todos
= False
86 # Disable highlighting unless a language is specified, otherwise we'll get
87 # python keywords highlit in literal blocks.
88 highlight_language
= "none"
91 # -- Options for HTML output ----------------------------------------------
93 # The theme to use for HTML and HTML Help pages. See the documentation for
94 # a list of builtin themes.
96 html_theme
= 'sphinx_rtd_theme'
98 html_favicon
= "favicon.ico"
100 # Theme options are theme-specific and customize the look and feel of a theme
101 # further. For a list of options available for each theme, see the
104 html_theme_options
= {
105 'display_version': False,
108 html_copy_source
= False
110 # Add any paths that contain custom static files (such as style sheets) here,
111 # relative to this directory. They are copied after the builtin static files,
112 # so a file named "default.css" will overwrite the builtin "default.css".
113 html_static_path
= []
117 'release-maintainers-keys.asc',
126 # -- Options for HTMLHelp output ------------------------------------------
128 # Output file base name for HTML help builder.
129 htmlhelp_basename
= 'TheMesa3DGraphicsLibrarydoc'
132 # -- Options for LaTeX output ---------------------------------------------
135 # The paper size ('letterpaper' or 'a4paper').
137 # 'papersize': 'letterpaper',
139 # The font size ('10pt', '11pt' or '12pt').
141 # 'pointsize': '10pt',
143 # Additional stuff for the LaTeX preamble.
147 # Latex figure (float) alignment
149 # 'figure_align': 'htbp',
152 # Grouping the document tree into LaTeX files. List of tuples
153 # (source start file, target name, title,
154 # author, documentclass [howto, manual, or own class]).
156 (master_doc
, 'TheMesa3DGraphicsLibrary.tex', 'The Mesa 3D Graphics Library Documentation',
157 'Brian Paul', 'manual'),
161 # -- Options for manual page output ---------------------------------------
163 # One entry per manual page. List of tuples
164 # (source start file, name, description, authors, manual section).
166 (master_doc
, 'themesa3dgraphicslibrary', 'The Mesa 3D Graphics Library Documentation',
171 # -- Options for Texinfo output -------------------------------------------
173 # Grouping the document tree into Texinfo files. List of tuples
174 # (source start file, target name, title, author,
175 # dir menu entry, description, category)
176 texinfo_documents
= [
177 (master_doc
, 'TheMesa3DGraphicsLibrary', 'The Mesa 3D Graphics Library Documentation',
178 author
, 'TheMesa3DGraphicsLibrary', 'One line description of project.',