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 <erik.faye-lund@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/24507>
This commit is contained in:
Jani Nikula
2023-07-29 14:55:50 +03:00
committed by Marge Bot
parent 67485efd65
commit 91587326ae
2 changed files with 5 additions and 1 deletions

View File

@@ -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',