diff options
| author | Scott Shawcroft <scott@chickadee.tech> | 2016-10-18 17:42:47 -0700 |
|---|---|---|
| committer | Scott Shawcroft <scott@chickadee.tech> | 2016-10-18 17:42:47 -0700 |
| commit | 46e7f8e4fb172207121516f5bd15d162aedd041d (patch) | |
| tree | 7ff3890e7a3339402587f995d3a6c7099194fe61 /docs/README.md | |
| parent | cb99ae50328de982244ed5cd486ccd57f5bd93bd (diff) | |
Documentation rework to unify the docs together rather than having them
on a per port basis.
Also enables generating docs from inline RST in C code. Simply omits all
lines except those that start with //|. Indentation after "//| " will be
preserved.
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 32 |
1 files changed, 9 insertions, 23 deletions
diff --git a/docs/README.md b/docs/README.md index faf386710..6e7925811 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,16 +1,16 @@ -MicroPython Documentation +Adafruit's MicroPython Documentation ========================= -The MicroPython documentation can be found at: -http://docs.micropython.org/en/latest/ +The latest documentation can be found at: +http://adafruit-micropython.readthedocs.io/en/latest/ -The documentation you see there is generated from the files in the docs tree: -https://github.com/micropython/micropython/tree/master/docs +The documentation you see there is generated from the files in the whole tree: +https://github.com/adafruit/micropython/tree/master Building the documentation locally ---------------------------------- -If you're making changes to the documentation, you may want to build the +If you're making changes to the documentation, you should build the documentation locally so that you can preview your changes. Install Sphinx, and optionally (for the RTD-styling), sphinx_rtd_theme, @@ -19,22 +19,8 @@ preferably in a virtualenv: pip install sphinx pip install sphinx_rtd_theme -In `micropython/docs`, build the docs: +In `micropython/`, build the docs: - make MICROPY_PORT=<port_name> html + sphinx-build -v -b html . _build/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`. - -PDF manual generation ---------------------- - -This can be achieved with: - - make MICROPY_PORT=<port_name> latexpdf - -but require rather complete install of LaTeX with various extensions. On -Debian/Ubuntu, try (500MB+ download): - - apt-get install texlive-latex-recommended texlive-latex-extra +You'll find the index page at `micropython/docs/_build/html/index.html`. |