diff options
| author | evildmp <daniele@vurt.org> | 2014-11-06 00:14:26 +0000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2014-11-15 19:01:19 +0000 |
| commit | aec189a5ba4e1feac82625507851d4188f6dd510 (patch) | |
| tree | 7d9781ae28543267fad13d2fe99ab684834433e3 /README.md | |
| parent | ca0b0cb83f55afddc0b8055f6283dc13f7cafdc6 (diff) | |
docs: Add optional sphinx_rtd_theme; add docs build instructions.
The sphinx_rtd_theme is used by ReadTheDocs to render a pretty looking
documentation. If you have this theme installed locally then your
locally-compiled docs will look exactly like the published
documentation. Otherwise it falls back to the default theme.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -98,3 +98,18 @@ AUR. If the above does not work it may be because you don't have the correct permissions. Try then: $ sudo dfu-util -a 0 -d 0483:df11 -D build-PYBV10/firmware.dfu + +Building the documentation locally +---------------------------------- + +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 html + +You'll find the index page at `micropython/docs/build/html/index.html`. |
