1Source Documentation 2==================== 3 4`Doxygen <http://www.doxygen.nl>`__ is used to automatically produce 5cross-referenced documentation from the Mesa source code. 6 7The Doxygen configuration files and generated files are not included in 8the normal Mesa distribution (they're very large). To generate Doxygen 9documentation, download Mesa from git, change to the ``doxygen`` 10directory and run ``make``. 11 12For an example of Doxygen usage in Mesa, see a recent source file such 13as 14`bufferobj.c <https://gitlab.freedesktop.org/mesa/mesa/-/blob/master/src/mesa/main/bufferobj.c>`__. 15 16If you're reading this page from your local copy of Mesa, and have run 17the doxygen scripts, you can read the documentation 18`here <../doxygen/main/index.html>`__ 19 20Gallium is also documented using Sphinx. The generated output can be 21found `on Gallium.ReadTheDocs.io <https://gallium.readthedocs.io>`__. 22