Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
M
micropython
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
card10
micropython
Commits
98fb0bf6
Commit
98fb0bf6
authored
9 years ago
by
Dave Hylands
Committed by
Damien George
9 years ago
Browse files
Options
Downloads
Patches
Plain Diff
docs: Move instructions on generating the documentation to docs/README.md
parent
040f6f67
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+4
-14
4 additions, 14 deletions
README.md
docs/README.md
+28
-0
28 additions, 0 deletions
docs/README.md
with
32 additions
and
14 deletions
README.md
+
4
−
14
View file @
98fb0bf6
...
...
@@ -151,19 +151,9 @@ correct permissions. Try then:
$ sudo dfu-util -a 0 -d 0483:df11 -D build-PYBV10/firmware.dfu
Building the d
ocumentation
locally
-------------
---------------------
D
ocumentation
-------------
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=<port_name> BUILDDIR=build/<port_name> html
Where
`<port_name>`
can be
`unix`
,
`pyboard`
,
`wipy`
or
`esp8266`
.
You'll find the index page at
`micropython/docs/<port_name>/build/html/index.html`
.
This diff is collapsed.
Click to expand it.
docs/README.md
0 → 100644
+
28
−
0
View file @
98fb0bf6
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=<port_name> BUILDDIR=build/<port_name> 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`
.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment