README.md
1# Documentation Source Folder
2
3This folder contains source files of **esptool documentation**.
4
5The sources do not render well in GitHub and some information is not visible at all.
6
7Use actual documentation generated within about 20 minutes on each commit:
8
9# Hosted Documentation
10
11* English: https://docs.espressif.com/projects/esptool/
12
13The above URL is for the master branch latest version. Click the drop-down in the bottom left to choose a particular version.
14
15# Building Documentation
16
17The documentation is built using the python package `esp-docs`, which can be installed by running `pip install esp-docs`. Running `build-docs --help` will give a summary of available options. For more information see the `esp-docs` documentation at https://github.com/espressif/esp-docs/blob/master/README.md
18
