diff options
Diffstat (limited to 'docs/sourcedocs.rst')
| -rw-r--r-- | docs/sourcedocs.rst | 60 |
1 files changed, 16 insertions, 44 deletions
diff --git a/docs/sourcedocs.rst b/docs/sourcedocs.rst index 18fae0447a..af9592fe07 100644 --- a/docs/sourcedocs.rst +++ b/docs/sourcedocs.rst @@ -1,49 +1,21 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html lang="en"><head> - <meta content="text/html; charset=utf-8" http-equiv="content-type"/> - <title>Source Code Documentation</title> - <link href="mesa.css" rel="stylesheet" type="text/css"/> -</head> -<body> +Source Code Documentation +========================= +`Doxygen <http://www.doxygen.org>`__ is used to automatically produce +cross-referenced documentation from the Mesa source code. +The Doxygen configuration files and generated files are not included in +the normal Mesa distribution (they're very large). To generate Doxygen +documentation, download Mesa from git, change to the ``doxygen`` +directory and run ``make``. +For an example of Doxygen usage in Mesa, see a recent source file such +as +`bufferobj.c <https://cgit.freedesktop.org/mesa/mesa/tree/src/mesa/main/bufferobj.c>`__. +If you're reading this page from your local copy of Mesa, and have run +the doxygen scripts, you can read the documentation +`here <../doxygen/main/index.html>`__ - -<h1>Source Code Documentation</h1> - -<p> -<a href="http://www.doxygen.org">Doxygen</a> -is used to automatically -produce cross-referenced documentation from the Mesa source code. -</p> - -<p> -The Doxygen configuration files and generated files are not included -in the normal Mesa distribution (they're very large). -To generate Doxygen documentation, download Mesa from git, change to -the <code>doxygen</code> directory and run <code>make</code>. -</p> - -<p> -For an example of Doxygen usage in Mesa, see a recent source file -such as <a href="https://cgit.freedesktop.org/mesa/mesa/tree/src/mesa/main/bufferobj.c">bufferobj.c</a>. -</p> - - -<p> -If you're reading this page from your local copy of Mesa, and have -run the doxygen scripts, you can read the documentation -<a href="../doxygen/main/index.html">here</a> -</p> - -<p> -Gallium is also documented using Sphinx. The generated output can be found -<a href="https://gallium.readthedocs.io">on Gallium.ReadTheDocs.io</a>. -</p> - - - - -</body></html>
\ No newline at end of file +Gallium is also documented using Sphinx. The generated output can be +found `on Gallium.ReadTheDocs.io <https://gallium.readthedocs.io>`__. |