Add dcumentation (#12)

* added sphinx documentation * filled in most missing docstrings * updated README and setup.py, added CONTRIBUTING * added docs build target
2017-12-12 11:14:33 +01:00
parent bfced82ae4
commit 53ac55a24b
41 changed files with 1821 additions and 447 deletions
@@ -27,6 +27,13 @@
        </value>
      </option>
    </inspection_tool>
+    <inspection_tool class="PyPep8Inspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
+      <option name="ignoredErrors">
+        <list>
+          <option value="E402" />
+        </list>
+      </option>
+    </inspection_tool>
    <inspection_tool class="PyPep8NamingInspection" enabled="false" level="WEAK WARNING" enabled_by_default="false">
      <option name="ignoredErrors">
        <list>
@@ -42,6 +49,7 @@
          <option value="format" />
          <option value="type" />
          <option value="filter" />
+          <option value="copyright" />
        </list>
      </option>
    </inspection_tool>