Erik Faye-Lund | 00cd134 | 2019-05-02 23:21:36 +0200 | [diff] [blame] | 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 | # |
Erik Faye-Lund | 2f81398 | 2020-06-30 12:44:19 +0200 | [diff] [blame] | 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')) |
Erik Faye-Lund | 00cd134 | 2019-05-02 23:21:36 +0200 | [diff] [blame] | 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. |
Erik Faye-Lund | 64a4ba9 | 2020-07-02 12:14:28 +0200 | [diff] [blame] | 41 | extensions = ['sphinx.ext.graphviz', 'formatting', 'redirects'] |
Erik Faye-Lund | 00cd134 | 2019-05-02 23:21:36 +0200 | [diff] [blame] | 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 | |
Erik Faye-Lund | dcaab1b | 2019-06-04 15:15:39 +0200 | [diff] [blame] | 90 | # Disable highlighting unless a language is specified, otherwise we'll get |
| 91 | # python keywords highlit in literal blocks. |
| 92 | highlight_language = "none" |
| 93 | |
Erik Faye-Lund | 00cd134 | 2019-05-02 23:21:36 +0200 | [diff] [blame] | 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 | |
Laura Ekstrand | 8342fe8 | 2018-06-11 15:42:39 -0700 | [diff] [blame] | 102 | html_favicon = "favicon.ico" |
| 103 | |
Erik Faye-Lund | 00cd134 | 2019-05-02 23:21:36 +0200 | [diff] [blame] | 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 | # |
Laura Ekstrand | 21adb67 | 2018-06-06 14:43:35 -0700 | [diff] [blame] | 108 | html_theme_options = { |
| 109 | 'display_version': False, |
| 110 | } |
Erik Faye-Lund | 00cd134 | 2019-05-02 23:21:36 +0200 | [diff] [blame] | 111 | |
Erik Faye-Lund | 12760d0 | 2020-09-16 11:54:21 +0200 | [diff] [blame] | 112 | html_context = { |
| 113 | 'display_gitlab': True, |
| 114 | 'gitlab_host': 'gitlab.freedesktop.org', |
| 115 | 'gitlab_user': 'mesa', |
| 116 | 'gitlab_repo': 'mesa', |
| 117 | 'gitlab_version': 'master', |
| 118 | 'conf_py_path': '/docs/', |
| 119 | } |
| 120 | |
Erik Faye-Lund | 17aefa7 | 2019-06-10 20:15:08 +0200 | [diff] [blame] | 121 | html_copy_source = False |
| 122 | |
Erik Faye-Lund | 00cd134 | 2019-05-02 23:21:36 +0200 | [diff] [blame] | 123 | # Add any paths that contain custom static files (such as style sheets) here, |
| 124 | # relative to this directory. They are copied after the builtin static files, |
| 125 | # so a file named "default.css" will overwrite the builtin "default.css". |
| 126 | html_static_path = [] |
| 127 | |
Erik Faye-Lund | dd3add1 | 2020-04-18 11:44:57 +0200 | [diff] [blame] | 128 | html_extra_path = [ |
Erik Faye-Lund | 381fc0e | 2020-04-18 11:54:11 +0200 | [diff] [blame] | 129 | '_extra/', |
Eric Engestrom | 677c1bd | 2020-06-20 00:35:58 +0200 | [diff] [blame] | 130 | 'release-maintainers-keys.asc', |
Erik Faye-Lund | dd3add1 | 2020-04-18 11:44:57 +0200 | [diff] [blame] | 131 | 'features.txt', |
| 132 | 'libGL.txt', |
| 133 | 'README.UVD', |
| 134 | 'README.VCE', |
| 135 | 'README.WIN32', |
Erik Faye-Lund | dd3add1 | 2020-04-18 11:44:57 +0200 | [diff] [blame] | 136 | ] |
| 137 | |
Erik Faye-Lund | 9a644d7 | 2020-10-21 13:50:11 +0200 | [diff] [blame] | 138 | html_redirects = [ |
Eric Anholt | 313f951 | 2020-10-16 10:35:17 -0700 | [diff] [blame] | 139 | ('gallium/drivers/freedreno', 'drivers/freedreno.html'), |
| 140 | ('gallium/drivers/freedreno/ir3-notes', 'drivers/freedreno/ir3-notes.html'), |
| 141 | ('gallium/drivers/llvmpipe', 'drivers/llvmpipe.html'), |
| 142 | ('gallium/drivers/openswr', 'drivers/openswr.html'), |
| 143 | ('gallium/drivers/openswr/faq', 'drivers/openswr/faq.html'), |
| 144 | ('gallium/drivers/openswr/knobs', 'drivers/openswr/knobs.html'), |
| 145 | ('gallium/drivers/openswr/profiling', 'drivers/openswr/profiling.html'), |
| 146 | ('gallium/drivers/openswr/usage', 'drivers/openswr/usage.html'), |
| 147 | ('gallium/drivers/zink', 'drivers/zink.html'), |
| 148 | ('llvmpipe', 'drivers/llvmpipe.html'), |
Erik Faye-Lund | 9a644d7 | 2020-10-21 13:50:11 +0200 | [diff] [blame] | 149 | ('postprocess', 'gallium/postprocess.html'), |
Eric Anholt | 4a4b854 | 2020-10-16 10:40:35 -0700 | [diff] [blame] | 150 | ('vmware-guest', 'drivers/vmware-guest.html'), |
Erik Faye-Lund | 9a644d7 | 2020-10-21 13:50:11 +0200 | [diff] [blame] | 151 | ('webmaster', 'https://www.mesa3d.org/website/'), |
| 152 | ] |
| 153 | |
Erik Faye-Lund | 00cd134 | 2019-05-02 23:21:36 +0200 | [diff] [blame] | 154 | |
| 155 | # -- Options for HTMLHelp output ------------------------------------------ |
| 156 | |
| 157 | # Output file base name for HTML help builder. |
| 158 | htmlhelp_basename = 'TheMesa3DGraphicsLibrarydoc' |
| 159 | |
| 160 | |
| 161 | # -- Options for LaTeX output --------------------------------------------- |
| 162 | |
| 163 | latex_elements = { |
| 164 | # The paper size ('letterpaper' or 'a4paper'). |
| 165 | # |
| 166 | # 'papersize': 'letterpaper', |
| 167 | |
| 168 | # The font size ('10pt', '11pt' or '12pt'). |
| 169 | # |
| 170 | # 'pointsize': '10pt', |
| 171 | |
| 172 | # Additional stuff for the LaTeX preamble. |
| 173 | # |
| 174 | # 'preamble': '', |
| 175 | |
| 176 | # Latex figure (float) alignment |
| 177 | # |
| 178 | # 'figure_align': 'htbp', |
| 179 | } |
| 180 | |
| 181 | # Grouping the document tree into LaTeX files. List of tuples |
| 182 | # (source start file, target name, title, |
| 183 | # author, documentclass [howto, manual, or own class]). |
| 184 | latex_documents = [ |
| 185 | (master_doc, 'TheMesa3DGraphicsLibrary.tex', 'The Mesa 3D Graphics Library Documentation', |
| 186 | 'Brian Paul', 'manual'), |
| 187 | ] |
| 188 | |
| 189 | |
| 190 | # -- Options for manual page output --------------------------------------- |
| 191 | |
| 192 | # One entry per manual page. List of tuples |
| 193 | # (source start file, name, description, authors, manual section). |
| 194 | man_pages = [ |
| 195 | (master_doc, 'themesa3dgraphicslibrary', 'The Mesa 3D Graphics Library Documentation', |
| 196 | [author], 1) |
| 197 | ] |
| 198 | |
| 199 | |
| 200 | # -- Options for Texinfo output ------------------------------------------- |
| 201 | |
| 202 | # Grouping the document tree into Texinfo files. List of tuples |
| 203 | # (source start file, target name, title, author, |
| 204 | # dir menu entry, description, category) |
| 205 | texinfo_documents = [ |
| 206 | (master_doc, 'TheMesa3DGraphicsLibrary', 'The Mesa 3D Graphics Library Documentation', |
| 207 | author, 'TheMesa3DGraphicsLibrary', 'One line description of project.', |
| 208 | 'Miscellaneous'), |
| 209 | ] |
Erik Faye-Lund | c853774 | 2020-07-02 13:24:06 +0200 | [diff] [blame] | 210 | |
| 211 | # -- Options for Graphviz ------------------------------------------------- |
| 212 | |
| 213 | graphviz_output_format = 'svg' |