Commit98fb0bf

authored and

committed

docs: Move instructions on generating the documentation to docs/README.md

1 parent040f6f6 commit98fb0bfCopy full SHA for 98fb0bf

File tree

+32

-14

lines changed

+32

-14

lines changed

Lines changed: 4 additions & 14 deletions

Original file line number	Diff line number	Diff line change
`@@ -151,19 +151,9 @@ correct permissions. Try then:`
`151`	`151`
`152`	`152`	`$ sudo dfu-util -a 0 -d 0483:df11 -D build-PYBV10/firmware.dfu`
`153`	`153`
`154`		`-Building the documentation locally`
`155`		`-----------------------------------`
	`154`	`+Documentation`
	`155`	`+-------------`
`156`	`156`
`157`		`-Install Sphinx, and optionally (for theRTD-styling), sphinx_rtd_theme,`
`158`		`-preferably in a virtualenv:`
	`157`	`+You can find information about thedocumentation in the`
	`158`	`+[docs/README.md](https://github.com/micropython/micropython/blob/master/docs/README.md) file.`
`159`	`159`
`160`		`- pip install sphinx`
`161`		`- pip install sphinx_rtd_theme`
`162`		`-`
`163`		-In`micropython/docs`, build the docs:
`164`		`-`
`165`		`-make MICROPY_PORT=<port_name> BUILDDIR=build/<port_name> html`
`166`		`-`
`167`		-Where`<port_name>` can be`unix`,`pyboard`,`wipy` or`esp8266`.
`168`		`-`
`169`		-You'll find the index page at`micropython/docs/<port_name>/build/html/index.html`.

Lines changed: 28 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,28 @@`
	`1`	`+MicroPython Documentation`
	`2`	`+=========================`
	`3`	`+`
	`4`	`+The MicroPython documentation can be found at:`
	`5`	`+http://docs.micropython.org/en/latest/`
	`6`	`+`
	`7`	`+The documentation you see there is generated from the files in the docs tree:`
	`8`	`+https://github.com/micropython/micropython/tree/master/docs`
	`9`	`+`
	`10`	`+Building the documentation locally`
	`11`	`+----------------------------------`
	`12`	`+`
	`13`	`+If you're making changes to the documentation, you may want to build the`
	`14`	`+documentation locally so that you can preview your changes.`
	`15`	`+`
	`16`	`+Install Sphinx, and optionally (for the RTD-styling), sphinx_rtd_theme,`
	`17`	`+preferably in a virtualenv:`
	`18`	`+`
	`19`	`+ pip install sphinx`
	`20`	`+ pip install sphinx_rtd_theme`
	`21`	`+`
	`22`	+In`micropython/docs`, build the docs:
	`23`	`+`
	`24`	`+make MICROPY_PORT=<port_name> BUILDDIR=build/<port_name> html`
	`25`	`+`
	`26`	+Where`<port_name>` can be`unix`,`pyboard`,`wipy` or`esp8266`.
	`27`	`+`
	`28`	+You'll find the index page at`micropython/docs/build/<port_name>/html/index.html`.

Comments

(0)