From 98fb0bf68a251741e341c3bfa74cc64f8a238c20 Mon Sep 17 00:00:00 2001 From: Dave Hylands Date: Sat, 31 Oct 2015 17:46:19 -0700 Subject: [PATCH] docs: Move instructions on generating the documentation to docs/README.md --- README.md | 18 ++++-------------- docs/README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 14 deletions(-) create mode 100644 docs/README.md 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= BUILDDIR=build/ html - -Where `` can be `unix`, `pyboard`, `wipy` or `esp8266`. - -You'll find the index page at `micropython/docs//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= BUILDDIR=build/ html + +Where `` can be `unix`, `pyboard`, `wipy` or `esp8266`. + +You'll find the index page at `micropython/docs/build//html/index.html`.