Commit 98fb0bf6 authored by Dave Hylands's avatar Dave Hylands Committed by Damien George
Browse files

docs: Move instructions on generating the documentation to docs/README.md

parent 040f6f67
......@@ -151,19 +151,9 @@ correct permissions. Try then:
$ sudo dfu-util -a 0 -d 0483:df11 -D build-PYBV10/firmware.dfu
Building the documentation locally
----------------------------------
Documentation
-------------
Install Sphinx, and optionally (for the RTD-styling), sphinx_rtd_theme,
preferably in a virtualenv:
You can find information about the documentation in the
[docs/README.md](https://github.com/micropython/micropython/blob/master/docs/README.md) file.
pip install sphinx
pip install sphinx_rtd_theme
In `micropython/docs`, build the docs:
make MICROPY_PORT=<port_name> BUILDDIR=build/<port_name> html
Where `<port_name>` can be `unix`, `pyboard`, `wipy` or `esp8266`.
You'll find the index page at `micropython/docs/<port_name>/build/html/index.html`.
MicroPython Documentation
=========================
The MicroPython documentation can be found at:
http://docs.micropython.org/en/latest/
The documentation you see there is generated from the files in the docs tree:
https://github.com/micropython/micropython/tree/master/docs
Building the documentation locally
----------------------------------
If you're making changes to the documentation, you may want to build the
documentation locally so that you can preview your changes.
Install Sphinx, and optionally (for the RTD-styling), sphinx_rtd_theme,
preferably in a virtualenv:
pip install sphinx
pip install sphinx_rtd_theme
In `micropython/docs`, build the docs:
make MICROPY_PORT=<port_name> BUILDDIR=build/<port_name> html
Where `<port_name>` can be `unix`, `pyboard`, `wipy` or `esp8266`.
You'll find the index page at `micropython/docs/build/<port_name>/html/index.html`.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment