Erik Faye-Lund
923a41ac99
docs: implement new vk-feat role
...
This makes it easy to link to a specific Vulkan feature from the docs.
Useful for the Zink docs.
Acked-by: Mike Blumenkrantz <michael.blumenkrantz@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/21813 >
2023-03-10 14:02:06 +00:00
Erik Faye-Lund
4eef5628c8
docs: drop custom envvar directive
...
The custom envvar directive is strange. It overloads the global
namespace, where there's already a well-known envvar directive, but the
envvar role won't resolve to envvars defined using the custom directive.
It's not really critical to declare the type and default value here, and
many descriptions already include this. Let's just use the plain one,
and let the description take care of the details where needed.
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593 >
2022-11-15 11:25:05 +01:00
Erik Faye-Lund
f69560bdcb
docs: add ext-role for spec extension links
...
This is a custom Sphinx role that generates links to GL and VK
extensions.
Reviewed-by: Eric Engestrom <eric@igalia.com >
Reviewed-by: Adam Jackson <ajax@redhat.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19594 >
2022-11-09 16:10:55 +00:00
Erik Faye-Lund
9a14ddc22d
docs: add license to the redirects script
...
I always intended this to be covered by the MIT license like with the
rest of my contributions, but somehow forgot to add it.
Let's add that license to make things clear.
Reviewed-by: Marcin Ślusarz <marcin.slusarz@intel.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/14751 >
2022-02-22 16:15:47 +00:00
Jason Ekstrand
1a14d98fa2
nir: Document all the ALU opcodes
...
Reviewed-by: Connor Abbott <cwabbott0@gmail.com >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11438 >
2021-06-21 16:47:00 +00:00
Erik Faye-Lund
2736370294
docs: do not generate redirects on error
...
The build-finished event is also triggered when there's an error. I
somehow got the second argument wrong, and ended up ignoring the case.
This can lead to new exceptions being thrown due to missing files, that
ends up hiding the real problem.
Fixes: 64a4ba9e1ceric@engestrom.ch >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10407 >
2021-05-05 09:37:18 +00:00
Erik Faye-Lund
9a644d7017
docs: specify redirects in conf.py instead
...
This makes it much easier to discover these.
Reviewed-by: Eric Anholt <eric@anholt.net >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7174 >
2020-10-21 18:11:39 +00:00
Erik Faye-Lund
47f52e83d1
docs: specify redirects relative to docs-root
...
It's a lot easier to reason about redirects if they're specified
relative to thje docs-root, so let's do that instead.
Reviewed-by: Eric Anholt <eric@anholt.net >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7174 >
2020-10-21 18:11:39 +00:00
Erik Faye-Lund
7daf953bc0
docs: verify that targets for relative redirects exist
...
This makes it a bit easier to update the redirects.
Reviewed-by: Eric Anholt <eric@anholt.net >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7174 >
2020-10-21 18:11:39 +00:00
Erik Faye-Lund
a85c3189fa
docs: create leading directories for redirects
...
This will be useful when removing entire directories from the docs,
which will happen in an upcoming patch.
Reviewed-by: Eric Anholt <eric@anholt.net >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7174 >
2020-10-21 18:11:39 +00:00
Erik Faye-Lund
e48b77b5b1
docs: remove webmaster article
...
This article is out-of-date, so let's instead forward to the "About
Mesa3D.org" article on the main website. This explains where to submit
merge requests for wanted changes.
Reviewed-by: Eric Engestrom <eric@engestrom.ch >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6862 >
2020-09-28 07:51:31 +00:00
Erik Faye-Lund
d2dfbf0e66
docs: store prefixes in redirects
...
This allows us to link to articles that are using pretty-URLs without
adding an ugly "/index.html"-suffix to them.
Reviewed-by: Eric Engestrom <eric@engestrom.ch >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6862 >
2020-09-28 07:51:30 +00:00
Erik Faye-Lund
026615c0f9
docs: fixup envvar output
...
Sphinx 2.x has changed how this works, and some of this whitespace now
gets stripped as a result. So let's instead actual whitespace as separate
text-nodes instead.
Reviewed-by: Eric Engestrom <eric@engestrom.ch >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5706 >
2020-07-07 10:22:08 +00:00
Erik Faye-Lund
892fdde23f
docs: move gallium specific docs into gallium folder
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5706 >
2020-07-07 10:22:08 +00:00
Erik Faye-Lund
64a4ba9e1c
docs: add an extension to generate redirects
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5706 >
2020-07-07 10:22:08 +00:00
Erik Faye-Lund
2f81398187
merge gallium docs into main docs
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch >
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5706 >
2020-07-07 10:22:08 +00:00
