From c5fdaf24ad12cf9b7af83adc0244de217b5a8f20 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Tue, 20 Feb 2018 12:58:23 +0100 Subject: [PATCH] Fix the requirements.txt file for docs/server, update README.md --- docs/README.md | 8 ++++++++ docs/server/requirements.txt | 1 - 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 220569e2..4071546f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,6 +16,14 @@ If you want to generate the HTML version of the long-form documentation on your pip install -r requirements.txt ``` +If you're building the *Server* docs (in `docs/server`) then you must also do: +```bash +pip install -e ../../ +``` + +Note: Don't put `-e ../../` in the `requirements.txt` file. That will work locally +but not on ReadTheDocs. + You can then generate the HTML documentation _in that subdirectory_ by doing: ```bash make html diff --git a/docs/server/requirements.txt b/docs/server/requirements.txt index cd06eab9..45600057 100644 --- a/docs/server/requirements.txt +++ b/docs/server/requirements.txt @@ -4,4 +4,3 @@ sphinx-rtd-theme>=0.1.9 sphinxcontrib-napoleon>=0.4.4 sphinxcontrib-httpdomain>=1.5.0 pyyaml>=3.12 -bigchaindb