summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorDave Hylands <dhylands@gmail.com>2015-10-31 17:46:19 -0700
committerDamien George <damien.p.george@gmail.com>2015-11-03 23:28:27 +0000
commit98fb0bf68a251741e341c3bfa74cc64f8a238c20 (patch)
treebe7bbd3ad0c4eb1e52a55590f46c9dc582b36372
parent040f6f6711c2365b19c7c7b5ff124c45208ea864 (diff)
downloadmicropython-98fb0bf68a251741e341c3bfa74cc64f8a238c20.tar.gz
micropython-98fb0bf68a251741e341c3bfa74cc64f8a238c20.zip
docs: Move instructions on generating the documentation to docs/README.md
-rw-r--r--README.md18
-rw-r--r--docs/README.md28
2 files changed, 32 insertions, 14 deletions
diff --git a/README.md b/README.md
index a63c8b9bb7..97ac19ed1b 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`.
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000000..d3e1e8d69e
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,28 @@
+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`.