Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 491 Bytes

README.md

File metadata and controls

27 lines (18 loc) · 491 Bytes

Documentation for the IDF Component Manager and ESP Component Registry

To build documentation locally, run these command from the root of the project

Install dependencies:

pip install .[docs]

Build the docs:

sphinx-build docs/en docs/html_output

Preview in the browser:

python -m webbrowser -t "file://$(pwd)/docs/html_output/index.html"

If you are using WSL, simply start the web server:

python -m http.server --directory docs/html_output