summaryrefslogtreecommitdiff
path: root/docs/_exts
Commit message (Collapse)AuthorAgeFilesLines
* docs: Include ALU opcode descriptionsAlyssa Rosenzweig2023-05-121-0/+2
| | | | | | | | | | | If we have a description for an ALU opcode in NIR, include it with our generated HTML documentation so people don't need to go to nir_opcodes.py anyway because the documentation is missing the documentation ;-) Signed-off-by: Alyssa Rosenzweig <alyssa@rosenzweig.io> Acked-by: Jesse Natalie <jenatali@microsoft.com> Tested-by: Jesse Natalie <jenatali@microsoft.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/22929>
* docs: remove support for old sphinx-versionsErik Faye-Lund2023-04-261-6/+1
| | | | | | | We're not using them, so no point in keeping support around. Reviewed-by: Eric Engestrom <eric@igalia.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8399>
* docs: translate admonitions into bootstrap alertsErik Faye-Lund2023-04-261-0/+23
| | | | | | | | Sphinx and Bootstraps disagree on what these are called. Let's try to bridge that gap, by rewriting things a bit. Reviewed-by: Eric Engestrom <eric@igalia.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8399>
* docs: add bootstrap extensionErik Faye-Lund2023-04-261-0/+108
| | | | | | | | | | | | | | | To get Sphinx and Bootstrap to work well together, we need to massage the output from Sphinx a bit. This adds an extension to do such changes, based on work from here: https://github.com/pydata/pydata-sphinx-theme ...However, because we don't ship as an external theme, we can't just do things as a part of __init__.py, so instead we register an extension that does the heavy lifting for us. Reviewed-by: Eric Engestrom <eric@igalia.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8399>
* docs: implement new vk-feat roleErik Faye-Lund2023-03-101-0/+10
| | | | | | | | 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>
* docs: drop custom envvar directiveErik Faye-Lund2022-11-151-14/+0
| | | | | | | | | | | | | 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>
* docs: add ext-role for spec extension linksErik Faye-Lund2022-11-091-0/+20
| | | | | | | | | 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>
* docs: add license to the redirects scriptErik Faye-Lund2022-02-221-0/+20
| | | | | | | | | | 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>
* nir: Document all the ALU opcodesJason Ekstrand2021-06-211-0/+151
| | | | | Reviewed-by: Connor Abbott <cwabbott0@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11438>
* docs: do not generate redirects on errorErik Faye-Lund2021-05-051-2/+2
| | | | | | | | | | | 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: 64a4ba9e1ce ("docs: add an extension to generate redirects") Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10407>
* docs: specify redirects in conf.py insteadErik Faye-Lund2020-10-211-7/+2
| | | | | | | 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>
* docs: specify redirects relative to docs-rootErik Faye-Lund2020-10-211-0/+2
| | | | | | | | 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>
* docs: verify that targets for relative redirects existErik Faye-Lund2020-10-211-0/+7
| | | | | | | 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>
* docs: create leading directories for redirectsErik Faye-Lund2020-10-211-0/+1
| | | | | | | | 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>
* docs: remove webmaster articleErik Faye-Lund2020-09-281-1/+2
| | | | | | | | | 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>
* docs: store prefixes in redirectsErik Faye-Lund2020-09-281-4/+3
| | | | | | | | 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>
* docs: fixup envvar outputErik Faye-Lund2020-07-071-2/+4
| | | | | | | | | 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>
* docs: move gallium specific docs into gallium folderErik Faye-Lund2020-07-071-1/+4
| | | | | Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5706>
* docs: add an extension to generate redirectsErik Faye-Lund2020-07-071-0/+19
| | | | | Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5706>
* merge gallium docs into main docsErik Faye-Lund2020-07-071-0/+31
Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5706>