44dba714f5
docs: update the required meson version
...
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/14240 >
2021-12-18 10:34:44 +00:00
ce4c96ea1b
gallium/swr: clean up the documentation after SWR removal from main
...
Reviewed-by: Dylan Baker <dylan@pnwbakers.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11264 >
2021-12-06 23:37:50 +00:00
ed04cb62d8
docs: use rst captions
...
This is slightly stronger semantically.
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11464 >
2021-06-21 08:22:51 +00:00
e41efc173b
docs: use more file-roles
...
This makes the documentation a bit easier to read, and aids
spell-checkers, so let's specify these using file-roles.
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11464 >
2021-06-21 08:22:51 +00:00
63c9d51981
docs: drop historic meson details
...
Similar to the last few commits, we require Meson 0.52 now. There's no
point in confusing users with specifying what versions supports what
here, as all supported versions works the same way now.
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11464 >
2021-06-21 08:22:51 +00:00
07cd8897fb
docs: remove outdated clarification
...
Similar to the previous commit, we now require Meson 0.52 all the time,
so there's no point in singling this out.
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11464 >
2021-06-21 08:22:51 +00:00
309b549f0e
docs: remove outdated meson-section
...
We're already requiring Meson 0.52, so there's no point in mentioning
this old work-around.
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11464 >
2021-06-21 08:22:51 +00:00
57897b4095
docs: Rename master branch to main
...
Signed-off-by: Jordan Justen <jordan.l.justen@intel.com>
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
2021-05-05 12:21:00 -07:00
7ef9379040
docs: use code-block for ini
...
These code-blocks are close enough to INI-files to parse that way, so
let's use that for some syntax-coloring :)
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10281 >
2021-04-26 08:39:02 +00:00
35bf5c4dca
docs: optimisation -> optimization
...
We generally prefer US English in the docs over UK English.
Acked-by: Matt Turner <mattst88@gmail.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/8572 >
2021-03-31 18:17:58 +02:00
d30470e999
docs: clang -> Clang
...
Reviewed-by: Daniel Stone <daniels@collabora.com>
Reviewed-by: Adam Jackson <ajax@redhat.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7060 >
2020-10-28 10:27:51 +00:00
0db015294e
docs: cmake -> CMake
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:21 +00:00
12d925dc8d
docs: visual studio -> Visual Studio
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:21 +00:00
0e9d87eacc
docs: windows -> Windows
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:21 +00:00
557ee09c2e
docs: microsoft -> Microsoft
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:21 +00:00
d84420f513
docs: mingw -> MinGW
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:21 +00:00
a14d64757b
docs: ninja -> Ninja
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:21 +00:00
eb1e7e61e5
docs: chocolatey -> Chocolatey
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:21 +00:00
0732efbda9
docs: mako -> Mako
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:20 +00:00
fafd1f4425
docs: bison -> Bison
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:20 +00:00
1e75294e82
docs: flex -> Flex
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:20 +00:00
d95e2e48a9
docs: python3 -> Python 3
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:20 +00:00
e198fb64e1
docs: meson -> Meson
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:20 +00:00
0835ee9e8d
docs: correct reference to meson.build
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:20 +00:00
5ed6432eeb
docs: llvm -> LLVM
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/6915 >
2020-09-30 08:18:20 +00:00
9497a1fbe7
docs: fix a bunch of typos
...
Saw a couple myself, and a quick round of vimspell showed a bunch more.
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Alyssa Rosenzweig <alyssa.rosenzweig@collabora.com>
Reviewed-by: Erik Faye-Lund <erik.faye-lund@collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5814 >
2020-07-09 14:06:34 +00:00
b1c16e5251
docs: use ref-links for internal references
...
Ref-link have two benefits over generic links:
1. They produce the right result for non-HTML outputs
2. They get validated at build-time
So let's use them for internal references instead.
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5671 >
2020-06-28 09:06:57 +00:00
1d250bf291
docs: restore accidentally dropped labels
...
These were accidentally dropped when cleaning up the TOC, making links to
them dead. Because we used plain links, sphinx didn't inform us that
these became dead. Let's restore them.
Fixes: 14f2a81b6fhttps://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5671 >
2020-06-28 09:06:57 +00:00
2ef983dca6
driconf: drop now unused translation facility
...
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5440 >
2020-06-22 21:50:12 +00:00
e94a122642
docs: suggest alternative installation methods for meson
...
A couple of popular distros have a habit of never updating anything.
Point their users towards ways of using current versions of meson anyway.
Signed-off-by: Eric Engestrom <eric.engestrom@intel.com>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/2988 >
2020-06-19 18:05:25 +00:00
62abe35e34
docs: use rst-note for highlighted text
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630 >
2020-06-13 10:42:01 +00:00
14f2a81b6f
docs: drop open-coded toc for articles
...
Sphinx already provides a proper table-of-contents, so we don't need to
roll our own.
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630 >
2020-06-13 10:42:01 +00:00
d6be994ef8
docs: use code-blocks
...
Sphinx can syntax-highlight a block if we use the right syntax.
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630 >
2020-06-13 10:42:00 +00:00
bf3f0f7a82
docs: format notes as rst-notes
...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630 >
2020-06-13 10:42:00 +00:00
0841da2fbb
docs: fixup heading-levels
...
I have no idea why pandoc messed up these headers...
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630 >
2020-06-13 10:42:00 +00:00
4d066836e3
docs: convert articles to reructuredtext
...
This uses the previously added scripts to convert the documentation to
reStructuredText, which is both easier to read offline, and can be used
to generate modern HTML for online documentation.
No modification to the generated results have been done.
Acked-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630 >
2020-06-13 10:42:00 +00:00
Thomas H.P. Andersen
Jan Zielinski
Erik Faye-Lund
Jordan Justen
Eric Engestrom
Eric Engestrom