Add nix-shell tools, fix circleci, resolves #322

This commit is contained in:
Wolfgang Walther
2020-11-29 23:54:48 +01:00
committed by Wolfgang Walther
parent ea2e166aa1
commit b83ee94fae
7 changed files with 176 additions and 94 deletions
+6 -9
View File
@@ -2,20 +2,17 @@
PostgREST docs use the reStructuredText format, check this [cheatsheet](https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst) to get acquainted with it.
You can use [pipenv](https://pipenv.readthedocs.io) to build the docs locally:
```bash
pipenv install
pipenv run python livereload_docs.py
```
Or if you use [nix](https://nixos.org/nix/), you can just run:
To build the docs locally, use [nix](https://nixos.org/nix/):
```bash
nix-shell
```
Both of these options will build the docs and start a livereload server on `http://localhost:5500`.
Once in the nix-shell you have the following commands available:
- `postgrest-docs-build`: Build the docs.
- `postgrest-docs-serve`: Build the docs and start a livereload server on `http://localhost:5500`.
- `postgrest-docs-spellcheck`: Run aspell.
## Documentation structure