mirror of
https://github.com/letscontrolit/ESPEasy.git
synced 2026-09-12 01:24:04 +00:00
36 lines
839 B
ReStructuredText
36 lines
839 B
ReStructuredText
Documentation
|
|
*************
|
|
|
|
For documentation we use Sphinx and this will be read by ReadTheDocs.
|
|
We use the `Sphinx Bootstrap Theme <https://github.com/ryan-roemer/sphinx-bootstrap-theme>`_
|
|
|
|
This documentation is included in the GitHub repository.
|
|
It allows us to create documentation per version of ESPEasy.
|
|
|
|
See also the `ESPEasy wiki <https://www.letscontrolit.com/wiki/index.php/ESPEasy>`_
|
|
for more documentation which has not been moved here.
|
|
|
|
Needed Python packages::
|
|
|
|
pip install sphinx recommonmark sphinx_bootstrap_theme
|
|
|
|
PlatformIO with Atom
|
|
====================
|
|
|
|
With the ESPEasy project open in Atom, open the PIO terminal in Atom.
|
|
|
|
Install dependencies::
|
|
|
|
cd docs
|
|
pip install ... (see needed Python packages above)
|
|
|
|
Build on Windows::
|
|
|
|
cd docs
|
|
.\make.bat html
|
|
|
|
Build on Linux/Mac::
|
|
|
|
cd docs
|
|
./make html
|