Add doxygen note

This commit is contained in:
Otto Winter 2018-06-03 11:37:08 +02:00
parent f905911276
commit cfbb9aacc4
No known key found for this signature in database
GPG Key ID: DB66C0BE6013F97E
1 changed files with 27 additions and 0 deletions

View File

@ -187,6 +187,33 @@ Then, use the provided Makefile to build the changes and start a simple web serv
# Start web server on port 8000
make webserver
If you also want to work on the API docs, you need to install `doxygen <http://www.stack.nl/~dimitri/doxygen/>`__
and you need to have a special folder structure:
.. code::
├── esphomedocs/
│   ├── api/
│   ├── esphomeyaml/
│   ├── Doxygen
│   ├── Makefile
│   ├── index.rst
│   └── ...
└── esphomelib/
├── src/
├── examples/
├── library.json
├── platformio.ini
└── ...
To update the internal doxygen API documentation, run:
.. code:: bash
make doxyg
# Then:
make html
Some notes about the docs:
* Use the english language (duh...)