aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTony DiCola <tony@tonydicola.com>2017-08-16 15:23:42 -0700
committerTony DiCola <tony@tonydicola.com>2017-08-16 15:23:42 -0700
commitc281b44cbdc22709a639cee1fc072f37568848aa (patch)
tree0c4ca3afb0062405016b29bad430359b8adb4a03
parente00b3190ede75b37fb1ff91bd9ca6d53c38d921d (diff)
Update docs README to mention requirement for recommonmark dependency.
-rw-r--r--docs/README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md
index 9b188a98a..15db6aef1 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -13,10 +13,11 @@ 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, and optionally (for the RTD-styling), sphinx_rtd_theme,
+Install Sphinx, recommonmark, and optionally (for the RTD-styling), sphinx_rtd_theme,
preferably in a virtualenv:
pip install sphinx
+ pip install recommonmark
pip install sphinx_rtd_theme
In `circuitpython/`, build the docs: