aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDave Hylands2015-10-31 17:46:19 -0700
committerDamien George2015-11-03 23:28:27 +0000
commit98fb0bf68a251741e341c3bfa74cc64f8a238c20 (patch)
treebe7bbd3ad0c4eb1e52a55590f46c9dc582b36372 /README.md
parent040f6f6711c2365b19c7c7b5ff124c45208ea864 (diff)
docs: Move instructions on generating the documentation to docs/README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 4 insertions, 14 deletions
diff --git a/README.md b/README.md
index a63c8b9bb..97ac19ed1 100644
--- a/README.md
+++ b/README.md
@@ -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`.