Diff of /docs/README.md [000000] .. [d45a3a]

Switch to side-by-side view

--- a
+++ b/docs/README.md
@@ -0,0 +1,15 @@
+# Documentation
+
+The source for BPNet documentation is in this directory under `sources/`. 
+Our documentation uses extended Markdown, as implemented by [MkDocs](http://mkdocs.org) and wrapped by Keras.
+
+## Building the documentation
+
+- Install MkDocs: `pip install mkdocs`
+- If you are on OS-x, install `gnu-sed` from conda-forge `conda install -c conda-forge sed`. Make sure that `which sed` returns the right path.
+- `cd` to the `docs/` folder and run:
+    - `make build`      # Builds a static site in "site" directory
+	  - injects the docstrings into placeholders. See `docs/autogen.py` and `docs/templates/api/model.md`
+	  - converts the ipynbs (`docs/ipynb_pages.txt`) to .md
+	  - Converts the .md files to a static page. See `docs/mkdocs.yml`
+    - `mkdocs serve`    # Starts a local webserver:  [localhost:8000](localhost:8000)