From b8f2ffc0a306be9ec283566f817d2aa03ccb952a Mon Sep 17 00:00:00 2001 From: Joe Nelson Date: Mon, 27 Feb 2017 09:38:21 -0800 Subject: [PATCH] Instructions for building docs locally --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..bb9afe28e --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +#### Sphinx source files for PostgREST documentation + +To generate HTML version: + +1. Install Sphinx from the [sphinx website](http://sphinx-doc.org/latest/install.html) +2. Clone this repository +4. Generate HTML + ```bash + cd postgrest-docs + sphinx-build -b html -a -n . _build + + # open _build/index.html in your browser + ``` + +--- + +**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. +* For an easier time refreshing your local preview of docs as you change it, try [sphinx-autobuild](https://github.com/GaretJax/sphinx-autobuild).