Remove generated docs

Author: owickstrom

.travis.yml

@@ -31,7 +31,7 @@ install:
 - chmod a+x $HOME/purescript
 - npm install -g bower pulp@next
 - bower install
-- pip install --user -r docs-src/requirements.txt
+- pip install --user -r docs/requirements.txt
 
 script:
 - export VERSION=branch-job-$TRAVIS_JOB_NUMBER
@@ -47,7 +47,7 @@ deploy:
 - provider: s3
   access_key_id: "$AWS_ACCESS_KEY_ID"
   secret_access_key: "$AWS_ACCESS_KEY_SECRET"
-  local_dir: docs-src/target/release
+  local_dir: docs/target/release
   bucket: hyper.wickstrom.tech
   upload-dir: docs/$VERSION
   region: eu-west-1

Makefile

@@ -2,16 +2,16 @@ VERSION ?= $(shell git rev-parse --short HEAD)
 
 .PHONY: docs
 docs:
-	make -C docs-src release
+	make -C docs release
 
 deploy-docs: docs
-	aws s3 sync --region=eu-west-1 docs-src/target/release s3://hyper.wickstrom.tech/$(VERSION)
+	aws s3 sync --region=eu-west-1 docs/target/release s3://hyper.wickstrom.tech/docs/$(VERSION)
 
 .PHONY: examples
 examples:
 	# Disabled! This part of the docs should be moved to the respective
 	# repository instead.
-	# make -C docs-src/src/extensions/type-level-routing/examples build
+	# make -C docs/src/extensions/type-level-routing/examples build
 	#
-	pulp build -I docs-src/src/topic-guides
+	pulp build -I docs/src/topic-guides
 	pulp build -I examples

docs-src/README.md

@@ -1,2 +1,36 @@
-# THIS IS AUTO-GENERATED, DO NOT EDIT
-Instead edit the sources in [docs-src](../docs-src).
+# Hyper Documentation
+
+The Hyper documentation is built using Sphinx and reStructured Text.
+
+## Prerequisites
+
+* [A TeX Distribution](https://www.latex-project.org/get/)
+* [virtualenv](https://virtualenv.pypa.io/en/stable/)
+
+## Setup
+
+```bash
+# Change to this directory in your terminal
+cd docs-src
+virtualenv ENV
+ENV/bin/activate
+pip install -r requirements.txt
+```
+
+## Building HTML
+
+```bash
+make html
+```
+
+Or, a handy live-reloading server for when you are writing documentation:
+
+```bash
+make livehtml
+```
+
+## Building the PDF
+
+```bash
+make latexpdf
+```