Skip to content

Commit

Permalink
Merge branch 'current' into next
Browse files Browse the repository at this point in the history
  • Loading branch information
jesserockz committed Oct 21, 2024
2 parents 5353164 + b99a7c6 commit 65d6dc6
Show file tree
Hide file tree
Showing 9 changed files with 194 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
repo: cloudcannon/pagefind
-
name: Checkout source code
uses: actions/[email protected].0
uses: actions/[email protected].1
-
name: Set up QEMU
uses: docker/setup-qemu-action@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
uses: jaxxstorm/[email protected]
with:
repo: cloudcannon/pagefind
- uses: actions/[email protected].0
- uses: actions/[email protected].1
- name: Set up Python 3.8
uses: actions/setup-python@v5
with:
Expand Down
9 changes: 9 additions & 0 deletions _static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,15 @@ img.logo {
background-color: #212121;
}

.sphinx-tabs-panel {
background: #212121;
}

.sphinx-tabs-tab {
background: #212121 !important;
margin: 0 !important;
}

img.logo {
content: url("/_static/logo-text-on-dark.svg");
}
Expand Down
16 changes: 16 additions & 0 deletions changelog/2024.10.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,22 @@ This is also a breaking change as the previous ``web_server_sorting_weight`` has

Please see :ref:`config-webserver-sorting` for the latest documentation on these features.

ESP32 Advanced MAC Address Configuration
----------------------------------------

ESPHome now supports reading a custom MAC address from the ESP32 eFuse blocks and will read and use it by default if
there is data burned into the eFuses. If you would like to disable this, or the eFuse has data burned that is not a
MAC address into those eFuses, then you can add ``ignore_efuse_custom_mac: true`` to your ESP32 ``advanced``
configuration. This option is currently only supported when using ESP-IDF as the framework.


CSE7766 Breaking Changes
------------------------

The :doc:`/components/sensor/cse7766` now requires even parity in configuration. There are some chips that work without ``EVEN``,
but the majority of newer chips seem to require it and the older ones work fine with it set as well so to make it consistent across all devices
the component now requires it.


Full list of changes
--------------------
Expand Down
4 changes: 2 additions & 2 deletions components/number/modbus_controller.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ Configuration variables:
- ``U_DWORD_R`` (unsigned 32 bit integer from 2 registers low word first)
- ``S_DWORD_R`` (signed 32 bit integer from 2 registers low word first)
- ``U_QWORD`` (unsigned 64 bit integer from 4 registers = 64bit)
- ``S_QWORD`` (unsigned 64 bit integer from 4 registers = 64bit)
- ``S_QWORD`` (signed 64 bit integer from 4 registers = 64bit)
- ``U_QWORD_R`` (unsigned 64 bit integer from 4 registers low word first)
- ``U_QWORD_R`` signed 64 bit integer from 4 registers low word first)
- ``S_QWORD_R`` (signed 64 bit integer from 4 registers low word first)
- ``FP32`` (32 bit IEEE 754 floating point from 2 registers)
- ``FP32_R`` (32 bit IEEE 754 floating point - same as FP32 but low word first)

Expand Down
2 changes: 1 addition & 1 deletion components/tca9555.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ TCA9555 I/O Expander
:description: Instructions for setting up TCA9555 digital port expanders in ESPHome.

The TCA9555 component allows you to use TCA955 I/O expanders
(`datasheet <https://www.ti.com/lit/ds/symlink/tca9555.pdf>`) in ESPHome. It uses :ref:`I²C Bus <i2c>` for communication.
(`datasheet <https://www.ti.com/lit/ds/symlink/tca9555.pdf>`__) in ESPHome. It uses :ref:`I²C Bus <i2c>` for communication.

Once configured, you can use any of the 16 pins (TCA9555) as
pins for your projects. Within ESPHome they emulate a real internal GPIO pin
Expand Down
2 changes: 2 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
"seo",
"components",
"sitemap",
"sphinx_tabs.tabs",
"sphinx_toolbox.collapse",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
159 changes: 159 additions & 0 deletions guides/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,165 @@ adhere to the following order:

Note that a blank line is *required* after every ``code-block`` directive.

- **Collapsible section**: To add a collapsible section, use the ``collapse`` directive:

.. code-block:: rst
.. collapse:: Details
Something small enough to escape casual notice.
.. collapse:: Details

Something small enough to escape casual notice.

.. code-block:: rst
.. collapse:: A long code block
.. code-block:: yaml
# Sample configuration entry
switch:
- platform: gpio
name: "Relay #42"
pin: GPIOXX
.. collapse:: A long code block

.. code-block:: yaml
# Sample configuration entry
switch:
- platform: gpio
name: "Relay #42"
pin: GPIOXX
The ``:open:`` flag can be used to have the section open by default.

.. code-block:: rst
.. collapse:: Open
:open:
This section is open by default.
.. collapse:: Open
:open:

This section is open by default.

.. note::

- The ``:open:`` flag must immediately follow the ``collapse`` directive without a blank line between them.
- A blank line is *required* after every ``collapse`` directive.

- **Tabs**: To group content into tabs, use the ``tabs`` directive. The tabs directive defines a tab set.
Basic tabs are added using the ``tab`` directive (without s), which takes the tab’s label as an argument:

.. code-block:: rst
.. tabs::
.. tab:: Apples
Apples are green, or sometimes red.
.. tab:: Pears
Pears are green.
.. tab:: Oranges
Oranges are orange.
This will appear as

.. tabs::

.. tab:: Apples

Apples are green, or sometimes red.

.. tab:: Pears

Pears are green.

.. tab:: Oranges

Oranges are orange.

Tabs can also be nested inside one another:

.. code-block:: rst
.. tabs::
.. tab:: Stars
.. tabs::
.. tab:: The Sun
The closest star to us.
.. tab:: Proxima Centauri
The second closest star to us.
.. tab:: Polaris
The North Star.
.. tab:: Moons
.. tabs::
.. tab:: The Moon
Orbits the Earth
.. tab:: Titan
Orbits Jupiter
.. tabs::

.. tab:: Stars

.. tabs::

.. tab:: The Sun

The closest star to us.

.. tab:: Proxima Centauri

The second closest star to us.

.. tab:: Polaris

The North Star.

.. tab:: Moons

.. tabs::

.. tab:: The Moon

Orbits the Earth

.. tab:: Titan

Orbits Jupiter

.. note::

- A blank line is *required* after every ``tabs`` directive.
- The contents of each tab can be displayed by clicking on the tab that you wish to show.
Clicking again on the tab that is currently open will hide its content, leaving only the tab set labels visible.
- For advanced features like tab-groupings, refer to https://sphinx-tabs.readthedocs.io/en/latest/

- **Images**: Use the ``figure`` directive to display an image:

.. code-block:: rst
Expand Down
4 changes: 3 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
sphinx==5.0.1
sphinx==7.1.2
sphinx-autobuild==2021.3.14
sphinx-tabs==3.4.5
sphinx-toolbox==3.8.0

0 comments on commit 65d6dc6

Please sign in to comment.