diff options
| author | Jason Ekstrand <jason@jlekstrand.net> | 2021-06-14 16:55:21 -0500 |
|---|---|---|
| committer | Marge Bot <eric+marge@anholt.net> | 2021-06-18 13:03:48 +0000 |
| commit | 831750b40b67ed07b7473d17531f70fb23b4e9b5 (patch) | |
| tree | 7542744433d4845b28e8f41fbb4051ffef0031c7 /docs/conf.py | |
| parent | d3a63149dadcf9aa5b34a4cab884a233a6d6c75c (diff) | |
| download | mesa-831750b40b67ed07b7473d17531f70fb23b4e9b5.tar.gz | |
docs: Begin documenting ISL
This commit mostly just adds the framework required to scrape
documentation out of the ISL sources and headers. The method chosen
here is a combination of doxygen and breathe (a sphinx extension for
doxygen integration). I'll freely admit that doxygen is pretty terrible
but it seems like the best option we have available to us today.
Acked-by: Emma Anholt <emma@anholt.net>
Acked-by: Daniel Stone <daniels@collabora.com>
Acked-by: Erik Faye-Lund <erik.faye-lund@collabora.com>.
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11366>
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py index 3938638092d..079016cdd35 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,7 +38,7 @@ sys.path.append(os.path.abspath('_exts')) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['sphinx.ext.graphviz', 'formatting', 'redirects'] +extensions = ['sphinx.ext.graphviz', 'breathe', 'formatting', 'redirects'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -212,3 +212,11 @@ texinfo_documents = [ # -- Options for Graphviz ------------------------------------------------- graphviz_output_format = 'svg' + +# -- Options for breathe -------------------------------------------------- +breathe_projects = { + 'mesa' : 'doxygen_xml', +} +breathe_default_project = 'mesa' +breathe_show_define_initializer = True +breathe_show_enumvalue_initializer = True |