Skip to content

Commit

Permalink
docs/README: Add short paragraph about using readthedocs.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
tve authored and dpgeorge committed Jan 12, 2020
1 parent 977b532 commit bc5c993
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/README.md
Expand Up @@ -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
---------------------

Expand Down

0 comments on commit bc5c993

Please sign in to comment.