From 00975dba01cb53fdfed5b28341547b8db75af123 Mon Sep 17 00:00:00 2001
From: Mike Lynch <nycynik@gmail.com>
Date: Fri, 7 May 2021 14:40:22 -0700
Subject: [PATCH] adding readme to help folks build the docs if they are
 interested in doing so

---
 docs/README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 docs/README.md

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..2b9f87c
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,45 @@
+# Apex Documentation
+
+## Make the docs locally
+
+### Tool Installation
+
+In order to build the documentation in this folder, you need ot have Sphinx-doc installed. Follow the [instructions here](https://www.sphinx-doc.org/en/master/usage/installation.html) for your specific OS.
+
+For example, on Debian/Ubuntu:
+
+    apt-get install python3-sphinx 
+
+For OSX:
+
+    brew install sphinx-doc
+
+Anaconda
+
+    conda install sphinx
+
+Document building also requires make and dev tools.
+
+### Build the docs
+
+Once installed, you can use the make command to build the docs, for help simply type `make` in the `docs` director
+
+    cd docs
+    make
+
+For an example, if you wanted to build the docs as HTML, you would use
+
+    make html
+
+After running this command you should see "Build finished. The HTML pages are in build/html." To view your docs you can simply open them with a browser:
+
+   cd html
+
+and then open `index.html` in your browser.
+
+
+
+
+
+
+