mirror of
https://github.com/netfun2000/hipudding-teslamate.git
synced 2026-02-27 09:44:28 +08:00
29fa9c18fe
TeslaMate has a large amount of documentation that end-users may not be
away of. By using RTD we can have a full docsite with hierarchy
navigation structure to help improve discoverability.
I've broken the docs into these sections:
* Getting Started
* Sleep configuration
* Integrations
* Advanced configuration
* Development and Contribution
* Basic readthedocs/Sphinx support
* sphinx-markdown-tables for the table of environment variables
* `docs/conf.py` only minimal config needed.
* new `docs/index.rst` which is the root page, note that is is RST
* (ReStructured Text), not markdown. This file is also used to
* generate the left navigation bar.
* Use native markdown for images (inline HTML didn't work)
* Edit on GitHub link on the top right of every page, hopefully,
* makes it easier for Contributors
4 lines
98 B
ReStructuredText
4 lines
98 B
ReStructuredText
:orphan:
|
|
|
|
See online docs `https://teslamate.readthedocs.io/ <https://teslamate.readthedocs.io>`_
|