Module: Mesa Branch: main Commit: 91587326ae1c7b2fae7c70c92436933d72969be0 URL: http://cgit.freedesktop.org/mesa/mesa/commit/?id=91587326ae1c7b2fae7c70c92436933d72969be0
Author: Jani Nikula <[email protected]> Date: Sat Jul 29 14:55:50 2023 +0300 docs: Add docs/header-stubs/README.rst Mesa generates a number of headers during build. To make Clang based documentation parsing work without depending on the generated headers, start a directory hierarchy under docs/header-stubs/ for static mock headers. Reviewed-by: Erik Faye-Lund <[email protected]> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/24507> --- docs/conf.py | 3 ++- docs/header-stubs/README.rst | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 2f3fd7d3e82..2fb1e9e7b52 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -87,7 +87,7 @@ language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = [] +exclude_patterns = ['header-stubs'] # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -221,6 +221,7 @@ graphviz_output_format = 'svg' hawkmoth_root = os.path.abspath('..') hawkmoth_clang = [ + '-Idocs/header-stubs/', '-Iinclude/', '-Isrc/', '-DHAVE_STRUCT_TIMESPEC', diff --git a/docs/header-stubs/README.rst b/docs/header-stubs/README.rst new file mode 100644 index 00000000000..6451255d753 --- /dev/null +++ b/docs/header-stubs/README.rst @@ -0,0 +1,3 @@ +Mock headers and types used only for building documentation, to avoid a +documentation dependency on generated headers, and to allow documentation of the +generated types.
