Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-02-04 23:52:18 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch 'current' into beta

Browse Source
This commit is contained in:
Jesse Hills 2021-06-17 05:40:49 +12:00
commit fe5b781d75
No known key found for this signature in database
GPG Key ID: BEAAE804EFD8E83A
4 changed files with 73 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
.devcontainer/devcontainer.json Normal file
View File

@ -0,0 +1,27 @@
// https://github.com/microsoft/vscode-dev-containers/tree/v0.183.0/containers/python-3
{
"name": "ESPHome - docs",
"image": "mcr.microsoft.com/vscode/devcontainers/python:0-3.6",
"postCreateCommand": "pip3 install -r requirements.txt",
"forwardPorts": [8000],
"settings": {
"python.pythonPath": "/usr/local/bin/python",
"python.languageServer": "Pylance",
"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
},
"extensions": [
"ms-python.python",
"ms-python.vscode-pylance"
]
}

6
Makefile
View File

@ -21,14 +21,16 @@ help:
api: api:
mkdir -p _build/html/api mkdir -p _build/html/api
@if [ ! -d "$(ESPHOME_PATH)" ]; then \ @if [ ! -d "$(ESPHOME_PATH)" ]; then \
git clone --branch $(ESPHOME_REF) https://github.com/esphome/esphome.git $(ESPHOME_PATH); \ git clone --branch $(ESPHOME_REF) https://github.com/esphome/esphome.git $(ESPHOME_PATH) || \
git clone --branch beta https://github.com/esphome/esphome.git $(ESPHOME_PATH); \
fi fi
ESPHOME_PATH=$(ESPHOME_PATH) doxygen Doxygen ESPHOME_PATH=$(ESPHOME_PATH) doxygen Doxygen
netlify-api: netlify-dependencies netlify-api: netlify-dependencies
mkdir -p _build/html/api mkdir -p _build/html/api
@if [ ! -d "$(ESPHOME_PATH)" ]; then \ @if [ ! -d "$(ESPHOME_PATH)" ]; then \
git clone --branch $(ESPHOME_REF) https://github.com/esphome/esphome.git $(ESPHOME_PATH); \ git clone --branch $(ESPHOME_REF) https://github.com/esphome/esphome.git $(ESPHOME_PATH) || \
git clone --branch beta https://github.com/esphome/esphome.git $(ESPHOME_PATH); \
fi fi
ESPHOME_PATH=$(ESPHOME_PATH) ../doxybin/doxygen Doxygen ESPHOME_PATH=$(ESPHOME_PATH) ../doxybin/doxygen Doxygen

40
_static/custom.css
View File

@ -9,6 +9,10 @@ div.document {
margin-bottom: 50px; margin-bottom: 50px;
} }
div.body {
min-width: initial;
}
img.component-image { img.component-image {
border: none; border: none;
vertical-align: middle; vertical-align: middle;
@ -37,7 +41,7 @@ table.docutils {
} }
100% { 100% {
visibility: visible; visibility: visible;
} }
} }
@keyframes blink_effect { @keyframes blink_effect {
0% { 0% {
@ -57,14 +61,14 @@ table.docutils {
bottom: 0; bottom: 0;
right: 0; right: 0;
width: 100%; width: 100%;
background-color: rgba(20,20,20,0.8); background-color: rgba(20, 20, 20, 0.8);
min-height: 26px; min-height: 26px;
font-size: 14px; font-size: 14px;
color: #ccc; color: #ccc;
line-height: 26px; line-height: 26px;
padding: 8px 0 8px 30px; padding: 8px 0 8px 30px;
z-index: 9999; z-index: 9999;
display: none display: none;
} }
.footer-button-container { .footer-button-container {
margin: 0 60px 0 10px; margin: 0 60px 0 10px;
@ -118,7 +122,6 @@ div.index-shields {
margin-right: auto; margin-right: auto;
} }
.guide-container { .guide-container {
margin: 32px 0; margin: 32px 0;
display: flex; display: flex;
@ -126,18 +129,15 @@ div.index-shields {
} }
.guide-card { .guide-card {
color: #004B6B; color: #004b6b;
display: block; display: block;
height: auto; height: auto;
width: 300px; width: 300px;
background-color: #f3f6f6; background-color: #f3f6f6;
border-radius: 8px; border-radius: 8px;
box-shadow: -10px 10px 32px -12px #000; box-shadow: 4px 4px 8px -4px #00000075;
padding-bottom: 8px; padding-bottom: 8px;
} box-sizing: border-box;
.guide-card:not(:first-child) {
margin-left: -40px;
} }
.guide-card-title { .guide-card-title {
@ -152,14 +152,28 @@ div.index-shields {
white-space: pre-line; white-space: pre-line;
} }
@media screen and (min-width: 870px) {
.guide-card:first-child {
z-index: 100;
}
.guide-card:nth-child(2) {
z-index: 50;
}
.guide-card:not(:first-child) {
margin-left: -40px;
padding-left: 40px;
}
}
@media screen and (max-width: 870px) { @media screen and (max-width: 870px) {
.guide-container { .guide-container {
flex-direction: column-reverse; flex-direction: column;
} }
.guide-card { .guide-card {
width: 100%; width: 100%;
margin: 8px 0; margin: 8px 0;
padding: 0px;
} }
.guide-card:not(:first-child) { .guide-card:not(:first-child) {
margin-left: 0; margin-left: 0;
@ -167,4 +181,4 @@ div.index-shields {
.guide-card ul { .guide-card ul {
margin-left: 32px; margin-left: 32px;
} }
} }

30
index.rst
View File

@ -17,27 +17,27 @@ ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configu
<div class="guide-container"> <div class="guide-container">
<div class="guide-card"> <div class="guide-card">
<h3 class="guide-card-title">Keeping up</h3> <h3 class="guide-card-title">Getting started</h3>
<ul> <ul>
<li> <li>
<a class="reference" href="/changelog/index.html"> <a class="reference" href="/guides/getting_started_hassio.html">
Changelog ESPHome Dashboard
</a> </a>
</li> </li>
<li> <li>
<a class="reference" href="/guides/supporters.html"> <a class="reference" href="/guides/getting_started_command_line.html">
Supporters Command Line Interface
</a> </a>
</li> </li>
<li> <li>
<a class="reference" href="/guides/contributing.html"> <a class="reference" href="/guides/migrate_sonoff_tasmota.html">
Contributing Migrating from Tasmota
</a> </a>
</li> </li>
</ul> </ul>
<pre class="guide-code"> <pre class="guide-code">
esphome: esphome:
&nbsp;&nbsp;name: Awesome &nbsp;&nbsp;name: awesome
&nbsp;&nbsp;platform: ESP32 &nbsp;&nbsp;platform: ESP32
&nbsp;&nbsp;board: nodemcu-32s &nbsp;&nbsp;board: nodemcu-32s
</pre> </pre>
@ -68,21 +68,21 @@ ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configu
</ul> </ul>
</div> </div>
<div class="guide-card"> <div class="guide-card">
<h3 class="guide-card-title">Getting started</h3> <h3 class="guide-card-title">Keeping up</h3>
<ul> <ul>
<li> <li>
<a class="reference" href="/guides/getting_started_hassio.html"> <a class="reference" href="/changelog/index.html">
ESPHome Dashboard Changelog
</a> </a>
</li> </li>
<li> <li>
<a class="reference" href="/guides/getting_started_command_line.html"> <a class="reference" href="/guides/supporters.html">
Command Line Interface Supporters
</a> </a>
</li> </li>
<li> <li>
<a class="reference" href="/guides/migrate_sonoff_tasmota.html"> <a class="reference" href="/guides/contributing.html">
Migrating from Tasmota Contributing
</a> </a>
</li> </li>
</ul> </ul>