eeva/servant
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #1124 from domenkozar/docs

Browse source 
Bump docs dependencies and move docs docs to README
This commit is contained in:
Oleg Grenrus 2019-02-12 10:43:54 +02:00 committed by GitHub
commit 7e3853d030
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CONTRIBUTING.md
View file

@ -21,6 +21,7 @@ Or `nix`:
./scripts/generate-nix-files.sh # Get up-to-date shell.nix files ./scripts/generate-nix-files.sh # Get up-to-date shell.nix files
``` ```
To build the docs, see `doc/README.md`.
## General ## General

8
doc/README.md Normal file
View file

@ -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 .

8
doc/building-the-docs
View file

@ -1,8 +0,0 @@
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 .

1
doc/conf.py
View file

@ -167,7 +167,6 @@ texinfo_documents = [
# -- Markdown ------------------------------------------------------------- # -- Markdown -------------------------------------------------------------
source_parsers = { source_parsers = {
'.md': CommonMarkParser,
'.lhs': CommonMarkParser, '.lhs': CommonMarkParser,
} }

6
doc/requirements.txt
View file

@ -1,3 +1,3 @@
recommonmark==0.4.0 recommonmark==0.5.0
Sphinx==1.7.5 Sphinx==1.8.4
sphinx_rtd_theme>=0.4.0 sphinx_rtd_theme>=0.4.2