readthedocs

.readthedocs.yml

@@ -0,0 +1,19 @@
+version: 2
+
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+  fail_on_warning: false
+
+formats:
+  - pdf
+
+python:
+   version: 3.6
+   install:
+      - method: pip
+        path: .
+        extra_requirements:
+           - develop
+      - method: setuptools
+        path: .

docs/source/conf.py

@@ -16,10 +16,10 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # 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('../../compare50'))
 
 
 # -- General configuration ------------------------------------------------

setup.py

@@ -13,7 +13,7 @@
     description="This is compare50, with which you can compare files for similarities.",
     install_requires=["attrs>=18,<19.2.0", "intervaltree>=2.1.0,<3", "lib50>=2,<4", "numpy>=1.15,<2", "pygments>=2.2,<3", "jinja2>=2.10,<3", "termcolor>=1.1.0,<2", "tqdm>=4.32,<5"],
     extras_require = {
-        "develop": ["sphinx", "sphinx_rtd_theme", "line_profiler"]
+        "develop": ["sphinx", "sphinx_rtd_theme", "sphinx-autobuild", "line_profiler"]
     },
     keywords=["compare", "compare50"],
     name="compare50",