https://github.com/josverl/mp_autoapi
https://github.com/josverl/mp_autoapi
autoapi micropython sphinx
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/josverl/mp_autoapi
- Owner: Josverl
- Created: 2024-07-14T20:42:44.000Z (almost 2 years ago)
- Default Branch: Sphinx_AutoAPI
- Last Pushed: 2024-08-10T21:26:22.000Z (almost 2 years ago)
- Last Synced: 2025-04-12T12:55:33.896Z (about 1 year ago)
- Topics: autoapi, micropython, sphinx
- Language: Python
- Homepage: https://josverl.github.io/mp_autoapi/library/
- Size: 5.85 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: docs/README.md
Awesome Lists containing this project
README
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 html
You'll find the index page at `micropython/docs/build/html/index.html`.
Having readthedocs.org build the documentation
----------------------------------------------
If you would like to have docs for forks/branches hosted on GitHub, GitLab or
BitBucket an alternative to building the docs locally is to sign up for a free
https://readthedocs.org account. The rough steps to follow are:
1. sign-up for an account, unless you already have one
2. in your account settings: add GitHub as a connected service (assuming
you have forked this repo on github)
3. in your account projects: import your forked/cloned micropython repository
into readthedocs
4. in the project's versions: add the branches you are developing on or
for which you'd like readthedocs to auto-generate docs whenever you
push a change
PDF manual generation
---------------------
This can be achieved with:
make latexpdf
but requires a rather complete install of LaTeX with various extensions. On
Debian/Ubuntu, try (1GB+ download):
apt install texlive-latex-recommended texlive-latex-extra texlive-xetex texlive-fonts-extra cm-super xindy