docs: add github pages documentation

fhchl · Feb 27, 2019 · dc50f48 · dc50f48
1 parent fb760db
commit dc50f48
Show file tree

Hide file tree

Showing 2 changed files with 4,426 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -42,16 +42,14 @@ r.in_freq
 # and much more ...
 ```
 
-## Testing
+## Developing
 
 Run tests in base directory with
 
 	pytest
 
 Always run tests before pushing code.
 
-## Developing
-
 Install for development with `pip install -e .` .
 
 Comments should comply with the [Numpy/Scipy documentation style][1]. An
@@ -62,6 +60,10 @@ example can also be found [here][2]. Code should comply to the [pep8 coding styl
 
 Git commit messages follow [Angular style][4]. Uses [python-semantic-release][5] for versioning on travis-ci for pushs to master branch.
 
+Create documentation with
+
+    pdoc --html --overwrite --html-dir build response.py
+
 [1]: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
 [2]: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html
 [3]: https://www.python.org/dev/peps/pep-0008/