diff options
author | Thorsten von Eicken <tve@users.noreply.github.com> | 2020-01-06 09:48:16 -0800 |
---|---|---|
committer | Damien George <damien.p.george@gmail.com> | 2020-01-12 11:45:55 +1100 |
commit | bc5c993adfa1cfb888014213fb70ef0e6916f36a (patch) | |
tree | cff04f4fa4ca98069ce8fc8f59432922f385f4d8 | |
parent | 977b532c8fcd1a9e12844dd4f9cc2d70341013d7 (diff) |
docs/README: Add short paragraph about using readthedocs.
This adds a short paragraph on how to hook readthedocs.org up. The main
goal is to make people aware of the option, to help with contributing to
the documentation.
-rw-r--r-- | docs/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md index d524f4b67..1591911c3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -25,6 +25,21 @@ In `micropython/docs`, build the docs: 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 --------------------- |