Merge pull request #35 from INM-6/bug/fix_doc_api_reference

Documentation: insert paths in config file, future package and use py…

dicthash/__init__.py

@@ -4,14 +4,14 @@
 dicthash
 ========
 
-Conveniently generate portable md5 hashes from (arbitrarily nested)
+Generate portable md5 hashes from (arbitrarily nested)
 dictionaries. These dictionaries can contain arbitrary Python and
 NumPy data types. The goal of the module is to provide a hash function
 that can be safely used across different platforms. Its main use is to
 generate unique identifiers for parameter dictionaries used in
 parameter scans of neural network simulations.
 
-It exposes just a single function to the user `dicthash.generate_hash_from_dict`.
+It exposes a single function to the user `dicthash.generate_hash_from_dict`.
 
 """
 

doc/.readthedocs.yml

@@ -0,0 +1,2 @@
+python:
+   setup_py_install: true

doc/conf.py

@@ -17,9 +17,10 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('../dicthash'))
 
 
 # -- General configuration ------------------------------------------------
@@ -34,6 +35,7 @@
 extensions = ['sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.coverage',
+    'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode']
 
 # Add any paths that contain templates here, relative to this directory.

setup.py

@@ -11,6 +11,7 @@
     keywords='hashing hash',
     url='https://github.com/INM-6/python-dicthash',
     python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*, !=3.4.*, <4',
+    install_requires=['future'],
     packages=['dicthash'],
     long_description=open('README.md').read(),
     classifiers=[