mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-26 17:27:47 +01:00
commit
152a00d068
2
Doxygen
2
Doxygen
@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome"
|
|||||||
# could be handy for archiving the generated documentation or if some version
|
# could be handy for archiving the generated documentation or if some version
|
||||||
# control system is used.
|
# control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER = 2022.10.0b1
|
PROJECT_NUMBER = 2022.10.0b2
|
||||||
|
|
||||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||||
# for a project that appears at the top of each page and should give viewer a
|
# for a project that appears at the top of each page and should give viewer a
|
||||||
|
2
Makefile
2
Makefile
@ -1,5 +1,5 @@
|
|||||||
ESPHOME_PATH = ../esphome
|
ESPHOME_PATH = ../esphome
|
||||||
ESPHOME_REF = 2022.10.0b1
|
ESPHOME_REF = 2022.10.0b2
|
||||||
|
|
||||||
.PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
|
.PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
|
||||||
|
|
||||||
|
@ -1 +1 @@
|
|||||||
2022.10.0b1
|
2022.10.0b2
|
@ -44,6 +44,14 @@ Breaking Changes
|
|||||||
- Refactor xpt2046 to be a touchscreen platform :esphomepr:`3793` by :ghuser:`nielsnl68` (breaking-change)
|
- Refactor xpt2046 to be a touchscreen platform :esphomepr:`3793` by :ghuser:`nielsnl68` (breaking-change)
|
||||||
- Add ble RSSI sensor for connected devices :esphomepr:`3860` by :ghuser:`RoboMagus` (breaking-change)
|
- Add ble RSSI sensor for connected devices :esphomepr:`3860` by :ghuser:`RoboMagus` (breaking-change)
|
||||||
|
|
||||||
|
Beta Changes
|
||||||
|
^^^^^^^^^^^^
|
||||||
|
|
||||||
|
- fix never calling preset change trigger :esphomepr:`3864` by :ghuser:`glmnet`
|
||||||
|
- Modbus QWORD fix :esphomepr:`3856` by :ghuser:`dudanov`
|
||||||
|
- Send true and not RSSI in ble_presence :esphomepr:`3904` by :ghuser:`fjouault`
|
||||||
|
- Remove address type map from bluetooth proxy :esphomepr:`3905` by :ghuser:`jesserockz`
|
||||||
|
|
||||||
All changes
|
All changes
|
||||||
^^^^^^^^^^^
|
^^^^^^^^^^^
|
||||||
|
|
||||||
@ -74,6 +82,10 @@ All changes
|
|||||||
- Add support for ZHLT01 heatpump IR protocol :esphomepr:`3655` by :ghuser:`cfeenstra1024`
|
- Add support for ZHLT01 heatpump IR protocol :esphomepr:`3655` by :ghuser:`cfeenstra1024`
|
||||||
- Send GATT error events to HA :esphomepr:`3884` by :ghuser:`jesserockz`
|
- Send GATT error events to HA :esphomepr:`3884` by :ghuser:`jesserockz`
|
||||||
- Do not require CS pin for ST7789V :esphomepr:`3888` by :ghuser:`definitio`
|
- Do not require CS pin for ST7789V :esphomepr:`3888` by :ghuser:`definitio`
|
||||||
|
- fix never calling preset change trigger :esphomepr:`3864` by :ghuser:`glmnet`
|
||||||
|
- Modbus QWORD fix :esphomepr:`3856` by :ghuser:`dudanov`
|
||||||
|
- Send true and not RSSI in ble_presence :esphomepr:`3904` by :ghuser:`fjouault`
|
||||||
|
- Remove address type map from bluetooth proxy :esphomepr:`3905` by :ghuser:`jesserockz`
|
||||||
|
|
||||||
Past Changelogs
|
Past Changelogs
|
||||||
---------------
|
---------------
|
||||||
|
42
components.py
Normal file
42
components.py
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
import os
|
||||||
|
import json
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
def setup(app):
|
||||||
|
"""Setup connects events to the components output builder"""
|
||||||
|
app.connect("html-page-context", add_component_details)
|
||||||
|
app.connect("build-finished", create_output)
|
||||||
|
app.compoents_output = {}
|
||||||
|
|
||||||
|
is_production = os.getenv("NETLIFY") == "true"
|
||||||
|
|
||||||
|
return {
|
||||||
|
"version": "1.0.0",
|
||||||
|
"parallel_read_safe": True,
|
||||||
|
"parallel_write_safe": not is_production,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def add_component_details(app, pagename, templatename, context, doctree):
|
||||||
|
"""As each page is built, collect page details for the output."""
|
||||||
|
if pagename.startswith("components/"):
|
||||||
|
page_key = pagename[11:].replace("/", "_")
|
||||||
|
component_name = pagename.split("/")[-1]
|
||||||
|
page_data = {
|
||||||
|
"title": context["title"],
|
||||||
|
"url": context["pageurl"],
|
||||||
|
"path": context["pagename"],
|
||||||
|
}
|
||||||
|
if os.path.exists(os.path.join(app.builder.srcdir, "images", component_name + ".png")):
|
||||||
|
page_data["image"] = app.builder.config.html_baseurl + "/_images/" + component_name + ".png"
|
||||||
|
elif os.path.exists(os.path.join(app.builder.srcdir, "images", component_name + ".jpg")):
|
||||||
|
page_data["image"] = app.builder.config.html_baseurl + "/_images/" + component_name + ".jpg"
|
||||||
|
|
||||||
|
app.compoents_output[page_key] = page_data
|
||||||
|
|
||||||
|
|
||||||
|
def create_output(app, exception):
|
||||||
|
"""Generates the components.json from the collected component pages"""
|
||||||
|
with open(os.path.join(app.builder.outdir, "components.json"), "wt") as f:
|
||||||
|
f.write(json.dumps(app.compoents_output))
|
5
conf.py
5
conf.py
@ -39,7 +39,8 @@ sys.path.append(os.path.abspath("."))
|
|||||||
extensions = [
|
extensions = [
|
||||||
"github",
|
"github",
|
||||||
"seo",
|
"seo",
|
||||||
"sitemap",
|
"components",
|
||||||
|
"sitemap"
|
||||||
]
|
]
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
@ -68,7 +69,7 @@ author = "ESPHome"
|
|||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = "2022.10"
|
version = "2022.10"
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
release = "2022.10.0b1"
|
release = "2022.10.0b2"
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
|
@ -298,6 +298,7 @@ Contributors
|
|||||||
- `Christian Ferbar (@ferbar) <https://github.com/ferbar>`__
|
- `Christian Ferbar (@ferbar) <https://github.com/ferbar>`__
|
||||||
- `FeuerSturm (@FeuerSturm) <https://github.com/FeuerSturm>`__
|
- `FeuerSturm (@FeuerSturm) <https://github.com/FeuerSturm>`__
|
||||||
- `Frank Riley (@fhriley) <https://github.com/fhriley>`__
|
- `Frank Riley (@fhriley) <https://github.com/fhriley>`__
|
||||||
|
- `Frédéric Jouault (@fjouault) <https://github.com/fjouault>`__
|
||||||
- `fkirill (@fkirill) <https://github.com/fkirill>`__
|
- `fkirill (@fkirill) <https://github.com/fkirill>`__
|
||||||
- `Sean Vig (@flacjacket) <https://github.com/flacjacket>`__
|
- `Sean Vig (@flacjacket) <https://github.com/flacjacket>`__
|
||||||
- `Diego Elio Pettenò (@Flameeyes) <https://github.com/Flameeyes>`__
|
- `Diego Elio Pettenò (@Flameeyes) <https://github.com/Flameeyes>`__
|
||||||
@ -453,7 +454,6 @@ Contributors
|
|||||||
- `Javier Peletier (@jpeletier) <https://github.com/jpeletier>`__
|
- `Javier Peletier (@jpeletier) <https://github.com/jpeletier>`__
|
||||||
- `jsuanet (@jsuanet) <https://github.com/jsuanet>`__
|
- `jsuanet (@jsuanet) <https://github.com/jsuanet>`__
|
||||||
- `James Szalay (@jtszalay) <https://github.com/jtszalay>`__
|
- `James Szalay (@jtszalay) <https://github.com/jtszalay>`__
|
||||||
- `junnikokuki (@junnikokuki) <https://github.com/junnikokuki>`__
|
|
||||||
- `Justahobby01 (@Justahobby01) <https://github.com/Justahobby01>`__
|
- `Justahobby01 (@Justahobby01) <https://github.com/Justahobby01>`__
|
||||||
- `Mike Ryan (@justfalter) <https://github.com/justfalter>`__
|
- `Mike Ryan (@justfalter) <https://github.com/justfalter>`__
|
||||||
- `Justin Gerhardt (@justin-gerhardt) <https://github.com/justin-gerhardt>`__
|
- `Justin Gerhardt (@justin-gerhardt) <https://github.com/justin-gerhardt>`__
|
||||||
@ -465,7 +465,6 @@ Contributors
|
|||||||
- `Kris (@K-r-i-s-t-i-a-n) <https://github.com/K-r-i-s-t-i-a-n>`__
|
- `Kris (@K-r-i-s-t-i-a-n) <https://github.com/K-r-i-s-t-i-a-n>`__
|
||||||
- `Harald Nagel (@k7hpn) <https://github.com/k7hpn>`__
|
- `Harald Nagel (@k7hpn) <https://github.com/k7hpn>`__
|
||||||
- `kaegi (@kaegi) <https://github.com/kaegi>`__
|
- `kaegi (@kaegi) <https://github.com/kaegi>`__
|
||||||
- `kahrendt (@kahrendt) <https://github.com/kahrendt>`__
|
|
||||||
- `Karol Zlot (@karolzlot) <https://github.com/karolzlot>`__
|
- `Karol Zlot (@karolzlot) <https://github.com/karolzlot>`__
|
||||||
- `Kattni (@kattni) <https://github.com/kattni>`__
|
- `Kattni (@kattni) <https://github.com/kattni>`__
|
||||||
- `Krasimir Nedelchev (@kaykayehnn) <https://github.com/kaykayehnn>`__
|
- `Krasimir Nedelchev (@kaykayehnn) <https://github.com/kaykayehnn>`__
|
||||||
@ -898,4 +897,4 @@ Contributors
|
|||||||
- `Zack Barett (@zsarnett) <https://github.com/zsarnett>`__
|
- `Zack Barett (@zsarnett) <https://github.com/zsarnett>`__
|
||||||
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
||||||
|
|
||||||
*This page was last updated October 13, 2022.*
|
*This page was last updated October 15, 2022.*
|
||||||
|
@ -13,7 +13,7 @@ from docutils import nodes
|
|||||||
|
|
||||||
# This file is not processed by default as extension unless added.
|
# This file is not processed by default as extension unless added.
|
||||||
# To add this extension from command line use:
|
# To add this extension from command line use:
|
||||||
# -Dextensions=github,seo,sitemap,schema_doc"
|
# -Dextensions=github,seo,sitemap,components,schema_doc"
|
||||||
|
|
||||||
# also for improve performance running old version
|
# also for improve performance running old version
|
||||||
# -d_build/.doctrees-schema
|
# -d_build/.doctrees-schema
|
||||||
|
Loading…
Reference in New Issue
Block a user