From 324891206e5d32f58e0ff6ef221989644abef112 Mon Sep 17 00:00:00 2001 From: Otto Winter Date: Sun, 6 Jan 2019 18:56:14 +0100 Subject: [PATCH] Update docs --- Doxygen | 17 +- api/core/helpers.rst | 5 + api/core/index.rst | 1 + api/core/native-api.rst | 19 ++ api/core/time.rst | 24 +- api/core/wifi.rst | 21 +- api/light/addressable.rst | 12 + api/light/fastled.rst | 10 +- api/light/index.rst | 168 +------------- api/light/neopixelbus.rst | 24 ++ api/misc/stepper.rst | 29 +-- api/sensor/apds9960.rst | 9 + api/switch/index.rst | 2 + conf.py | 3 +- esphomeyaml/changelog/v1.10.0.rst | 11 +- esphomeyaml/changelog/v1.9.0.rst | 4 +- esphomeyaml/components/api.rst | 156 +++++++++++++ .../components/binary_sensor/index.rst | 37 ++- .../components/binary_sensor/template.rst | 2 +- esphomeyaml/components/cover/template.rst | 2 +- esphomeyaml/components/dallas.rst | 2 +- esphomeyaml/components/esp32_ble_beacon.rst | 2 +- esphomeyaml/components/esphomeyaml.rst | 25 +++ esphomeyaml/components/ethernet.rst | 89 ++++++++ .../components/light/fastled_clockless.rst | 2 +- esphomeyaml/components/light/index.rst | 79 +++---- esphomeyaml/components/light/neopixelbus.rst | 97 ++++++++ esphomeyaml/components/mqtt.rst | 4 +- esphomeyaml/components/sensor/adc.rst | 4 +- esphomeyaml/components/sensor/ads1115.rst | 2 +- esphomeyaml/components/sensor/apds9960.rst | 86 +++++++ esphomeyaml/components/sensor/bh1750.rst | 4 +- esphomeyaml/components/sensor/bme280.rst | 4 +- esphomeyaml/components/sensor/bme680.rst | 4 +- esphomeyaml/components/sensor/bmp085.rst | 4 +- esphomeyaml/components/sensor/bmp280.rst | 4 +- esphomeyaml/components/sensor/cse7766.rst | 2 +- esphomeyaml/components/sensor/dht.rst | 4 +- esphomeyaml/components/sensor/dht12.rst | 6 +- esphomeyaml/components/sensor/duty_cycle.rst | 4 +- esphomeyaml/components/sensor/esp32_hall.rst | 4 +- esphomeyaml/components/sensor/hdc1080.rst | 6 +- esphomeyaml/components/sensor/hlw8012.rst | 6 +- esphomeyaml/components/sensor/hmc5883l.rst | 6 +- .../components/sensor/homeassistant.rst | 43 ++++ esphomeyaml/components/sensor/htu21d.rst | 6 +- esphomeyaml/components/sensor/hx711.rst | 6 +- .../sensor/images/apds9960-full.jpg | Bin 0 -> 82704 bytes esphomeyaml/components/sensor/ina219.rst | 6 +- esphomeyaml/components/sensor/ina3221.rst | 6 +- esphomeyaml/components/sensor/index.rst | 19 -- esphomeyaml/components/sensor/max31855.rst | 6 +- esphomeyaml/components/sensor/max6675.rst | 6 +- esphomeyaml/components/sensor/mhz19.rst | 4 +- esphomeyaml/components/sensor/mpu6050.rst | 4 +- esphomeyaml/components/sensor/ms5611.rst | 4 +- .../components/sensor/pulse_counter.rst | 4 +- esphomeyaml/components/sensor/sht3xd.rst | 4 +- esphomeyaml/components/sensor/tcs34725.rst | 4 +- esphomeyaml/components/sensor/template.rst | 6 +- esphomeyaml/components/sensor/tsl2561.rst | 4 +- esphomeyaml/components/sensor/ultrasonic.rst | 2 +- esphomeyaml/components/sensor/uptime.rst | 4 +- esphomeyaml/components/sensor/wifi_signal.rst | 4 +- esphomeyaml/components/stepper/index.rst | 46 +++- esphomeyaml/components/switch/gpio.rst | 37 ++- esphomeyaml/components/switch/index.rst | 25 ++- .../components/text_sensor/homeassistant.rst | 35 +++ .../components/text_sensor/template.rst | 4 +- esphomeyaml/components/time.rst | 40 +++- esphomeyaml/components/wifi.rst | 34 +++ esphomeyaml/cookbook/bruh.rst | 2 +- esphomeyaml/cookbook/temt6000.rst | 2 +- esphomeyaml/guides/automations.rst | 212 +++++++----------- esphomeyaml/guides/configuration-types.rst | 30 +-- esphomeyaml/guides/faq.rst | 2 + esphomeyaml/images/apds9960.jpg | Bin 0 -> 70983 bytes esphomeyaml/images/ethernet.svg | 1 + esphomeyaml/index.rst | 17 ++ 79 files changed, 1066 insertions(+), 569 deletions(-) create mode 100644 api/core/native-api.rst create mode 100644 api/light/addressable.rst create mode 100644 api/light/neopixelbus.rst create mode 100644 api/sensor/apds9960.rst create mode 100644 esphomeyaml/components/api.rst create mode 100644 esphomeyaml/components/ethernet.rst create mode 100644 esphomeyaml/components/light/neopixelbus.rst create mode 100644 esphomeyaml/components/sensor/apds9960.rst create mode 100644 esphomeyaml/components/sensor/homeassistant.rst create mode 100644 esphomeyaml/components/sensor/images/apds9960-full.jpg create mode 100644 esphomeyaml/components/text_sensor/homeassistant.rst create mode 100644 esphomeyaml/images/apds9960.jpg create mode 100644 esphomeyaml/images/ethernet.svg diff --git a/Doxygen b/Doxygen index 4d547fd5f..5278e7080 100644 --- a/Doxygen +++ b/Doxygen @@ -213,7 +213,7 @@ MULTILINE_CPP_IS_BRIEF = NO # documentation from any documented member that it re-implements. # The default value is: YES. -INHERIT_DOCS = YES +INHERIT_DOCS = NO # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part @@ -329,7 +329,7 @@ AUTOLINK_SUPPORT = YES # diagrams that involve STL classes more complete and accurate. # The default value is: NO. -BUILTIN_STL_SUPPORT = NO +BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. @@ -502,7 +502,7 @@ HIDE_UNDOC_CLASSES = NO # included in the documentation. # The default value is: NO. -HIDE_FRIEND_COMPOUNDS = NO +HIDE_FRIEND_COMPOUNDS = YES # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these @@ -624,26 +624,26 @@ STRICT_PROTO_MATCHING = NO # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. -GENERATE_TODOLIST = YES +GENERATE_TODOLIST = NO # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. -GENERATE_TESTLIST = YES +GENERATE_TESTLIST = NO # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. -GENERATE_BUGLIST = YES +GENERATE_BUGLIST = NO # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. -GENERATE_DEPRECATEDLIST= YES +GENERATE_DEPRECATEDLIST= NO # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond @@ -821,6 +821,7 @@ FILE_PATTERNS = *.c \ *.cxx \ *.cpp \ *.c++ \ + *.tcc \ *.java \ *.ii \ *.ixx \ @@ -921,7 +922,7 @@ EXAMPLE_PATTERNS = *.cpp # irrespective of the value of the RECURSIVE tag. # The default value is: NO. -EXAMPLE_RECURSIVE = NO +EXAMPLE_RECURSIVE = YES # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the diff --git a/api/core/helpers.rst b/api/core/helpers.rst index 43a85c903..7e4b6208d 100644 --- a/api/core/helpers.rst +++ b/api/core/helpers.rst @@ -11,6 +11,11 @@ helpers.h .. doxygenfile:: esphomelib/helpers.h +util.h +****** + +.. doxygenfile:: esphomelib/uil.h + optional.h ********** diff --git a/api/core/index.rst b/api/core/index.rst index 3ee2913a1..925f45e8e 100644 --- a/api/core/index.rst +++ b/api/core/index.rst @@ -20,3 +20,4 @@ Core Time