From cfbb9aacc4931b6cc04b85aee6d3ae7a913a197e Mon Sep 17 00:00:00 2001
From: Otto Winter <otto@otto-winter.com>
Date: Sun, 3 Jun 2018 11:37:08 +0200
Subject: [PATCH] Add doxygen note

---
 esphomeyaml/guides/contributing.rst | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/esphomeyaml/guides/contributing.rst b/esphomeyaml/guides/contributing.rst
index d8af80baf..e44780469 100644
--- a/esphomeyaml/guides/contributing.rst
+++ b/esphomeyaml/guides/contributing.rst
@@ -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...)