galette/docs/README.md

   1 # Galette API documentation {#mainpage}
   2
   3 Galette API documentation can be generated using doxygen apigen (https://www.doxygen.nl/).
   4
   5 A file named Doxyfile is provided in the sources to automate the process.
   6 To generate the documentation, just run from galette doc (current) directory:
   7
   8 `$ doxygen`
   9
  10 HTML files will be generated into *apidocs* directory.
  11
  12 API documentation is generated every night along with the nighlty archive;
  13 you can see it at: https://apidoc.galette.eu