Bump docs dependencies and move docs docs to README
commit53b3b939e45a398c5b170ddd6f57ac4368e6f9b1
authorDomen Kožar <domen@dev.si>
dateTue 12 Feb 2019, 13:36 (8 years ago)
parent32ccc2d
CONTRIBUTING.md+1
@@ -21,6 +21,7 @@ Or `nix`:
2121./scripts/generate-nix-files.sh # Get up-to-date shell.nix files
2222```
2323
24+To build the docs, see `doc/README.md`.
2425
2526## General
2627
doc/README.mdnew file+8
@@ -0,0 +1,8 @@
1+To build the docs locally:
2+
3+ $ virtualenv venv
4+ $ . ./venv/bin/activate
5+ $ pip install -r requirements.txt
6+ $ make html
7+
8+Docs will be built in _build/html/index.html .
doc/building-the-docsdeleted−8
@@ -1,8 +0,0 @@
1−To build the docs locally:
2−
3−$ virtualenv venv
4−$ . ./venv/bin/activate
5−$ pip install -r requirements.txt
6−$ make html
7−
8−Docs will be built in _build/html/index.html .
doc/conf.py−1
@@ -167,7 +167,6 @@ texinfo_documents = [
167167# -- Markdown -------------------------------------------------------------
168168
169169source_parsers = {
170− '.md': CommonMarkParser,
171170 '.lhs': CommonMarkParser,
172171}
173172
doc/requirements.txt+3−3
@@ -1,3 +1,3 @@
1−recommonmark==0.4.0
2−Sphinx==1.7.5
3−sphinx_rtd_theme>=0.4.0
1+recommonmark==0.5.0
2+Sphinx==1.8.4
3+sphinx_rtd_theme>=0.4.2