docs: add util subpackage

hatchet · Aug 2, 2018 · dc59ba1 · dc59ba1
1 parent d88b2f4
commit dc59ba1
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,8 @@
 *.pyc
-*.metric-db
-/.cache
+.cache
+.pytest_cache
+
 experiment.xml
+docs/_build
+
+*.metric-db
diff --git a/docs/source/hatchet.rst b/docs/source/hatchet.rst
@@ -60,4 +60,6 @@ Subpackages
 .. toctree::
 
     hatchet.external
+    hatchet.util
+
 
diff --git a/docs/source/hatchet.util.rst b/docs/source/hatchet.util.rst
@@ -0,0 +1,22 @@
+hatchet.util package
+====================
+
+Submodules
+----------
+
+hatchet.util.timer module
+-------------------------
+
+.. automodule:: hatchet.util.timer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: hatchet.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/setup.py b/setup.py
@@ -21,6 +21,6 @@
         'License :: OSI Approved :: MIT License',
     ],
     keywords='',
-    packages = ['hatchet', 'hatchet.external'],
+    packages = ['hatchet', 'hatchet.util', 'hatchet.external'],
 )