summaryrefslogtreecommitdiff
path: root/docs/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* docs: use custom html themeErik Faye-Lund2023-04-261-24/+3
| | | | | | | | This uses the new custom HTML theme for Sphinx, so our documentation looks similar to our website. Reviewed-by: Eric Engestrom <eric@igalia.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8399>
* docs: sort extensionsErik Faye-Lund2023-04-261-1/+7
| | | | | | | | It's easier to keep this sorted if we have each element on a separate line. Let's do that for long-term ease of maintainability. Reviewed-by: Eric Engestrom <eric@igalia.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8399>
* docs: remove old thanks-articleErik Faye-Lund2023-03-211-0/+1
| | | | | | | | | | This article is so out of date it's of no real use any more, and updating it seems quite pointless. Let's just move it to the graveyard, and forward any readers to the version we have in the amber-release. Reviewed-by: Adam Jackson <ajax@redhat.com> Reviewed-by: Brian Paul <brianp@vmware.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/22028>
* docs: move developers article to main websiteErik Faye-Lund2023-03-211-0/+1
| | | | | | | | | | This isn't content that relates directly to a specific release of Mesa, and it's also quite out-of-date. Let's move it to the main mesa website instead, where we have an updated version. Reviewed-by: Adam Jackson <ajax@redhat.com> Reviewed-by: Brian Paul <brianp@vmware.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/22028>
* docs: do not linkcheck relnotesErik Faye-Lund2022-11-101-0/+1
| | | | | | | | | | There's a *lot* of relnotes, and we don't really actively maintain them. Let's drop linkchecking them to speed things up a bit. This does a whole lot of nothing unless you have Sphinx 4.4 or newer. Reviewed-by: Eric Engestrom <eric@igalia.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19574>
* docs: configure linkcheckErik Faye-Lund2022-11-101-0/+12
| | | | | Reviewed-by: Eric Engestrom <eric@igalia.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19574>
* docs: make c:expr the default-roleErik Faye-Lund2022-11-091-0/+1
| | | | | | | | Mesa is a C-project, so c:expr is a really handy role to default to. This means that `foo` is a short-hand for :c:expr:`foo`. Reviewed-by: Eric Engestrom <eric@igalia.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19575>
* docs: consistently use single-quotes in configErik Faye-Lund2022-11-041-2/+2
| | | | | Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19494>
* docs: set language to englishErik Faye-Lund2022-06-211-1/+1
| | | | | | | | | | | | | | | It seems recent versions of Sphinx has started issuing a warning when language isn't set to a recognized value. Since we're building with warnings as errors on CI, this causes issues for people. We're writing English docs, so we should set this to English. I probably confused this setting with the highlight_language setting or something when I set this up initially. Fixes: 00cd1346bf0 ("docs: use sphinx") Closes: https://gitlab.freedesktop.org/mesa/mesa/-/issues/6711 Reviewed-by: David Heidelberg <david.heidelberg@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/17159>
* docs: use http-redirect when possibleErik Faye-Lund2022-01-261-9/+0
| | | | | | | | | | | | | GitLab Pages has added a feature to do proper HTTP redirects, which are genreally better than the HTML redirects we currently use. Unfortunately, it doesn't support redirecting to other domains, all paths must start with a slash. So there's sadly *one* redirect this doesn't work for. So let's leave that one using a HTML redirect, and use HTTP redirects when we can. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/14369>
* gallium/swr: clean up the documentation after SWR removal from mainJan Zielinski2021-12-061-5/+0
| | | | | Reviewed-by: Dylan Baker <dylan@pnwbakers.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11264>
* nir: Document all the ALU opcodesJason Ekstrand2021-06-211-1/+1
| | | | | Reviewed-by: Connor Abbott <cwabbott0@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11438>
* docs: Begin documenting ISLJason Ekstrand2021-06-181-1/+9
| | | | | | | | | | | | | 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>
* docs: update master -> main in edit-linksErik Faye-Lund2021-06-071-1/+1
| | | | | | | | | | | Since the move from master to main, our "Edit on GitLab" links on docs.mesa3d.org has been pointing to the wrong branch. Let's fix this, so we don't confuse users who want to contribute changes. Acked-by: Adam Jackson <ajax@redhat.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11160>
* docs: rename vmware-guest articleErik Faye-Lund2021-06-031-0/+1
| | | | | | | | | | | | | | | | | No other drivers use the vendor in the title or path, so it seems better to not do this for the vmware-guest driver as well. So let's rename it to SVGA instead. The actual text itself makes it clear enough what it is about. This makes it stand out less in the toctree. I chose the name "WMware SVGA3D", because that's less ambigious than the "SVGA"-alternative, and was requested by VMware people.t Reviewed-by: Alyssa Rosenzweig <alyssa.rosenzweig@collabora.com> Reviewed-by: Chia-I Wu <olvaffe@gmail.com> Acked-by: Jose Fonseca <jfonseca@vmware.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11109>
* docs: remove out-of-date versions docErik Faye-Lund2021-04-271-0/+1
| | | | | | | | | | | | | | It seems nobody is interested in maintaining this info, and nobody seems to complain. We already have more or less the same information in our release-notes, so let's just redirect users there instead. Users interested in archeology can look through the git history for the information that's missing. Closes: https://gitlab.freedesktop.org/mesa/mesa/-/issues/4222 Reviewed-by: Adam Jackson <ajax@redhat.com> Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10451>
* docs: do not try to copy missing fileErik Faye-Lund2021-03-301-1/+0
| | | | | | | | This file was removed, but the inclusion in the docs build was missed. Fixes: 6e6cd7d93cc ("scons: Remove.") Acked-by: Daniel Stone <daniels@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/9913>
* docs: inline contents.rst into index.rstErik Faye-Lund2020-12-011-1/+1
| | | | | | | | | | | | | | | | | | The idea of having a single file containing the ToC is not really how things are done in Sphinx, and kinda makes it harder to structure documentation more naturally. This was just something I did to mirror what we used to do for the old HTML-only version of the docs, to ease the transition and to de-clutter index.rst. Now that the transition is far behind us, and index.rst is much cleaner, we can finally start inlining this. In the long run, I expect most of these to be moved to separate "chapter articles" that summarize what these topics are, and thus disappear from here. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
* docs/vmware: Move the vmware driver docs into the drivers section.Eric Anholt2020-10-211-0/+1
| | | | | | | For more consistency with the other drivers. Reviewed-by: Erik Faye-Lund <erik.faye-lund@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7174>
* docs: Move the gallium driver documentation to the top level.Eric Anholt2020-10-211-1/+10
| | | | | | | | | | | I actually had never found these, buried under Developer Topics -> Gallium -> Drivers. Given that driver documentation contains not just gallium driver documentation but also end-user information, bring it to a much more prominent location between User Topics and Developer Topics at the top level. Reviewed-by: Erik Faye-Lund <erik.faye-lund@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7174>
* docs: specify redirects in conf.py insteadErik Faye-Lund2020-10-211-0/+6
| | | | | | | 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: show 'Edit on GitLab'-linkErik Faye-Lund2020-09-281-0/+9
| | | | | | | | | It's easier to contribute to the documentation if we have links to the document on GitLab. This will allow people to easily edit docs, or to realize where in the source-tree they are without having to search. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6742>
* docs: use svg for graphviz outputErik Faye-Lund2020-07-071-0/+4
| | | | | | | This works a lot better on hidpi screens. 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-1/+1
| | | | | 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-4/+8
| | | | | Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5706>
* docs: cat maintainer keys to a single fileEric Engestrom2020-06-221-1/+1
| | | | | | | | | | | | | | The original issue asked for all the keys in a single file, but I didn't do that because it's much easier to manage and verify the keys as separate files, but sphinx doesn't provide a way to expose a folder so we'd need to create an index.html and have it list all the keys manually, which is very error prone. At this point, we might as well just concatenate the keys and expose a single file, so let's do that. Signed-off-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5568>
* docs: drop deleted file from extra sphinx filesEric Engestrom2020-06-221-1/+0
| | | | | | Fixes: 3e37b7e6bbad007c168a ("docs: remove plain-text copy of versions.rst") Signed-off-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5567>
* docs: publish our release maintainers' keysEric Engestrom2020-06-181-0/+1
| | | | | | | | | They should be published to various key servers as well, but this provides the authoritative source for their list. Closes: https://gitlab.freedesktop.org/mesa/mesa/issues/2140 Signed-off-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/2857>
* docs: include specs into the generated docsErik Faye-Lund2020-06-131-0/+1
| | | | | | | | | | Unfortunately, it doesn't seem like there's a way to have sphinx copy this without moving the files, becasue html_extra_path doesn't copy the directory itself when given a directory, only files inside and subdirectories. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
* docs: bundle extra filesErik Faye-Lund2020-06-131-0/+9
| | | | | | | | These are documents that are bundled in the root of the website, and contains some useful, extra documentation. Let's include them. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
* docs: Add the favicon to the new page.Laura Ekstrand2020-06-131-0/+2
| | | | | Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
* docs: do not copy source-files to siteErik Faye-Lund2020-06-131-0/+2
| | | | | | | | These docs have publically available sources in the first place, there's no point in including a copy of them here as well. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
* docs: Remove version.Laura Ekstrand2020-06-131-1/+3
| | | | | Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
* docs: disable syntax-highlighting by defaultErik Faye-Lund2020-06-131-0/+4
| | | | | | | | The default is python, which we don't really do a whole lot of in our docs, so let's just disable to none instead. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
* docs: use sphinxErik Faye-Lund2020-06-131-0/+160
Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
View Lorry Controller Status