Add pipenv instructions

This commit is contained in:
steve-chavez
2018-09-21 13:46:53 -05:00
parent 518b465ffa
commit 73e59a1643
5 changed files with 28 additions and 22 deletions
+9 -20
View File
@@ -2,28 +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.
To generate HTML version:
1. Install Sphinx from the [sphinx website](http://www.sphinx-doc.org/en/stable/install.html)
2. Clone this repository
3. Generate HTML
```bash
cd postgrest-docs
sphinx-build -b html -a -n . _build
# open _build/index.html in your browser
```
If you use [nix](https://nixos.org/nix/), you can just run:
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:
```bash
nix-shell
```
This will build the docs and start a livereload server on `http://localhost:5500`.
---
**Sphinx Installation Notes:**
* If you're on OSX you might want to install the Python from homebrew - then a simple `pip install sphinx` does the trick.
Both of these options will build the docs and start a livereload server on `http://localhost:5500`.