djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/README: Remove references to MICROPY_PORT when building docs.

Browse Source 
The docs are now built as one for all ports.
This commit is contained in:
Damien George 2018-12-11 02:55:22 +11:00
parent 025d419a77
commit beeeec292b
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/README.md
View File

@ -21,18 +21,16 @@ preferably in a virtualenv:
In `micropython/docs`, build the docs: In `micropython/docs`, build the docs:
make MICROPY_PORT=<port_name> html make html
Where `<port_name>` can be `unix`, `pyboard`, `wipy` or `esp8266`. You'll find the index page at `micropython/docs/build/html/index.html`.
You'll find the index page at `micropython/docs/build/<port_name>/html/index.html`.
PDF manual generation PDF manual generation
--------------------- ---------------------
This can be achieved with: This can be achieved with:
make MICROPY_PORT=<port_name> latexpdf make latexpdf
but require rather complete install of LaTeX with various extensions. On but require rather complete install of LaTeX with various extensions. On
Debian/Ubuntu, try (500MB+ download): Debian/Ubuntu, try (500MB+ download):