Bump docs dependencies and move docs docs to README

CraigTreptow · Feb 12, 2019 · 53b3b93 · 53b3b93
1 parent 32ccc2d
commit 53b3b93
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 12 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,6 +21,7 @@ Or `nix`:
 ./scripts/generate-nix-files.sh   # Get up-to-date shell.nix files
 ```
 
+To build the docs, see `doc/README.md`.
 
 ## General
 

diff --git a/doc/README.md b/doc/README.md
@@ -0,0 +1,8 @@
+To build the docs locally:
+
+    $ virtualenv venv
+    $ . ./venv/bin/activate
+    $ pip install -r requirements.txt
+    $ make html
+
+Docs will be built in _build/html/index.html .
diff --git a/doc/building-the-docs b/doc/building-the-docs
diff --git a/doc/conf.py b/doc/conf.py
@@ -167,7 +167,6 @@
 # -- Markdown -------------------------------------------------------------
 
 source_parsers = {
-    '.md': CommonMarkParser,
     '.lhs': CommonMarkParser,
 }
 
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,3 +1,3 @@
-recommonmark==0.4.0
-Sphinx==1.7.5
-sphinx_rtd_theme>=0.4.0
+recommonmark==0.5.0
+Sphinx==1.8.4
+sphinx_rtd_theme>=0.4.2
-Original file line number
+Diff line change
@@ Expand Up / @@ -21,6 +21,7 @@ Or `nix`: @@
     ./scripts/generate-nix-files.sh   # Get up-to-date shell.nix files
     ```
+    To build the docs, see `doc/README.md`.
     ## General
@@ Expand Down @@