From 98fb0bf68a251741e341c3bfa74cc64f8a238c20 Mon Sep 17 00:00:00 2001
From: Dave Hylands
Date: Sat, 31 Oct 2015 17:46:19 -0700
Subject: docs: Move instructions on generating the documentation to
 docs/README.md

---
 docs/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 docs/README.md

(limited to 'docs')

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 000000000..d3e1e8d69
--- /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`.
-- 
cgit v1.2.3