Merge pull request #33 from apiaryio/kylef/contributing

Add CONTRIBUTING guide
apiaryio · Jan 29, 2018 · 4747d49 · 4747d49
2 parents ce7eea4 + 1c912b9
commit 4747d49
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+# Contributing to API Elements Documentation
+
+The documentation is built using Sphinx, a Python tool. Assuming you have
+Python 3 installed, the following steps can be used to build the site.
+
+```shell
+$ python3 -m venv venv
+$ source venv/bin/activate
+$ pip install -r requirements.txt
+```
+
+## Running the Development Server
+
+You can run a local development server to preview changes using the following:
+
+```shell
+$ make watch
+```
diff --git a/Makefile b/Makefile
@@ -18,3 +18,6 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+watch:
+	sphinx-autobuild docs _build/html