docs/sourcedocs.rst

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