Merge pull request #85 from philippmeisberger/feature/read-the-docs

API documentation on readthedocs.io

README.md

@@ -1,5 +1,7 @@
 # Python library for ZFM fingerprint sensors
 
+[![Documentation Status](https://readthedocs.org/projects/pyfingerprint/badge/?version=latest)](https://pyfingerprint.readthedocs.io/en/latest/?badge=latest)
+
 The PyFingerprint library allows to use ZhianTec ZFM-20, ZFM-60, ZFM-70 and ZFM-100 fingerprint sensors on the Raspberry Pi or other Linux machines. Some other models like R302, R303, R305, R306, R307, R551 and FPM10A also work.
 
 **Note:** The library is inspired by the C++ library from Adafruit Industries:

doc/conf.py → docs/conf.py

@@ -3,12 +3,13 @@
 
 import datetime
 import sys
-sys.path.insert(0, '../src/files/')
+import os
+sys.path.append(os.path.join(os.path.dirname(__name__), '../src/files/'))
 
 import pyfingerprint
 
 project = u'PyFingerprint'
-master_doc = 'PyFingerprint'
+master_doc = 'index'
 author = 'Bastian Raschke <bastian.raschke@posteo.de>'
 copyright = '2014-{}, {}'.format(datetime.date.today().year, author)
 version = pyfingerprint.__version__
@@ -19,6 +20,8 @@
     '.DS_Store'
 ]
 extensions = [
-    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
 ]
 autoclass_content = "both"
+autodoc_mock_imports = ["serial"]
+html_theme = "sphinx_rtd_theme"

doc/PyFingerprint.rst → docs/index.rst

@@ -1,13 +1,11 @@
 PyFingerprint
 =============
 
+Python 2 and 3 library for ZFM fingerprint sensors.
+
 .. toctree::
    :maxdepth: 2
 
-.. topic:: Abstract
-
-    Python 2 and 3 library for ZFM fingerprint sensors.
-
 API Documentation
 *****************
 

src/debian/rules

@@ -15,4 +15,4 @@ override_dh_auto_build:
 	dh_auto_build
 
 	## Build API documentation
-	sphinx-build -b html ../doc ./build/html
+	sphinx-build -b singlehtml ../docs ./build/html