djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #5472 from fraziern/fraziern-docs-readme

Browse Source 
Update README in docs/
This commit is contained in:
Jeff Epler 2021-10-16 17:22:06 -05:00 committed by GitHub
commit 2736b46f81
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/README.md
View File

@ -13,12 +13,9 @@ Building the documentation locally
If you're making changes to the documentation, you should build the
documentation locally so that you can preview your changes.
Install Sphinx, recommonmark, and optionally (for the RTD-styling), sphinx_rtd_theme,
preferably in a virtualenv:
Install the necessary packages, preferably in a virtualenv, in `circuitpython/`:
pip install sphinx
pip install recommonmark
pip install sphinx_rtd_theme
pip install -r requirements-doc.txt
In `circuitpython/`, build the docs: