KonstantinSeurer
/
mesa
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
mesa/docs/index.rst

31 lines
1.2 KiB
ReStructuredText
Raw Normal View History

docs: use sphinx Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
2019-05-02 22:21:36 +01:00
.. include:: contents.rst
docs: drop news in favour of the introduction as index-page This kind of only makes sense once we have a separate home-page. But I think this is a good way of showing why we should do this; Sphinx doesn't support pagination, because it's not meant as a general-purpose website framewrork. And for documentation, pagination is not really something you need. There's probably a lot more pages that should be moved into a separate webpage, similar to this. In general, I think this should be done for pages that don't relate to the source code too much, e.g isn't needed to understand the code, or for instance explains how to get the source code. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
2020-01-30 18:27:17 +00:00
Introduction
============
The Mesa project began as an open-source implementation of the
docs: use external link-references The rST code here is much more to the point and easy to read if we define the links as external link-references instead of inlining them. This will make the next few patches much easier to grok. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 12:58:40 +00:00
`OpenGL`_ specification - a system for rendering interactive 3D graphics.
docs: drop news in favour of the introduction as index-page This kind of only makes sense once we have a separate home-page. But I think this is a good way of showing why we should do this; Sphinx doesn't support pagination, because it's not meant as a general-purpose website framewrork. And for documentation, pagination is not really something you need. There's probably a lot more pages that should be moved into a separate webpage, similar to this. In general, I think this should be done for pages that don't relate to the source code too much, e.g isn't needed to understand the code, or for instance explains how to get the source code. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
2020-01-30 18:27:17 +00:00
Over the years the project has grown to implement more graphics APIs,
docs: do not explicitly call out es-versions There's no reason to explicitly call out GL ES versions here, as these are all major versions there are, and it's very unlikely that more versions will emerge. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 13:01:27 +00:00
including `OpenGL ES`_, `OpenCL`_, `OpenMAX`_, `VDPAU`_, `VA API`_,
`XvMC`_ and `Vulkan`_.
docs: drop news in favour of the introduction as index-page This kind of only makes sense once we have a separate home-page. But I think this is a good way of showing why we should do this; Sphinx doesn't support pagination, because it's not meant as a general-purpose website framewrork. And for documentation, pagination is not really something you need. There's probably a lot more pages that should be moved into a separate webpage, similar to this. In general, I think this should be done for pages that don't relate to the source code too much, e.g isn't needed to understand the code, or for instance explains how to get the source code. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
2020-01-30 18:27:17 +00:00
A variety of device drivers allows the Mesa libraries to be used in many
different environments ranging from software emulation to complete
hardware acceleration for modern GPUs.
Mesa ties into several other open-source projects: the `Direct Rendering
docs: use external link-references The rST code here is much more to the point and easy to read if we define the links as external link-references instead of inlining them. This will make the next few patches much easier to grok. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 12:58:40 +00:00
Infrastructure`_ and `X.org`_ to provide OpenGL support on Linux, FreeBSD
docs: drop news in favour of the introduction as index-page This kind of only makes sense once we have a separate home-page. But I think this is a good way of showing why we should do this; Sphinx doesn't support pagination, because it's not meant as a general-purpose website framewrork. And for documentation, pagination is not really something you need. There's probably a lot more pages that should be moved into a separate webpage, similar to this. In general, I think this should be done for pages that don't relate to the source code too much, e.g isn't needed to understand the code, or for instance explains how to get the source code. Reviewed-by: Eric Engestrom <eric@engestrom.ch> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
2020-01-30 18:27:17 +00:00
and other operating systems.
docs: use external link-references The rST code here is much more to the point and easy to read if we define the links as external link-references instead of inlining them. This will make the next few patches much easier to grok. Reviewed-by: Eric Anholt <eric@anholt.net> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/7709>
2020-11-20 12:58:40 +00:00
.. _OpenGL: https://www.opengl.org/
.. _OpenGL ES: https://www.khronos.org/opengles/
.. _OpenCL: https://www.khronos.org/opencl/
.. _OpenMAX: https://www.khronos.org/openmax/
.. _VDPAU: https://en.wikipedia.org/wiki/VDPAU
.. _VA API: https://en.wikipedia.org/wiki/Video_Acceleration_API
.. _XvMC: https://en.wikipedia.org/wiki/X-Video_Motion_Compensation
.. _Vulkan: https://www.khronos.org/vulkan/
.. _Direct Rendering Infrastructure: https://dri.freedesktop.org/
.. _X.org: https://x.org