git.iko.soy/typeable/servant
on master help sign in
Merge pull request #1124 from domenkozar/docs
7e3853dOleg Grenrus
CONTRIBUTING.md+1
compare with master
unifiedsplit
@@ -21,6 +21,7 @@ Or `nix`:
21./scripts/generate-nix-files.sh # Get up-to-date shell.nix files
21./scripts/generate-nix-files.sh # Get up-to-date shell.nix files
22```
22```
23
23
24+To build the docs, see `doc/README.md`.
24
25
25## General
26## General
26
27
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 = [
167# -- Markdown -------------------------------------------------------------
167# -- Markdown -------------------------------------------------------------
168
168
169source_parsers = {
169source_parsers = {
170− '.md': CommonMarkParser,
171 '.lhs': CommonMarkParser,
170 '.lhs': CommonMarkParser,
172}
171}
173
172
doc/requirements.txt+3−3
@@ -1,3 +1,3 @@
1−recommonmark==0.4.0
1+recommonmark==0.5.0
2−Sphinx==1.7.5
2+Sphinx==1.8.4
3−sphinx_rtd_theme>=0.4.0
3+sphinx_rtd_theme>=0.4.2