Merge pull request #16 from pycompression/readthedocs

Create documentation on readthedocs.

Author: rhpvorderman

.readthedocs.yml

@@ -0,0 +1,9 @@
+version: 2
+formats: []  # Do not build epub and pdf
+
+python:
+  install:
+    - method: pip
+      path: .
+conda:
+  environment: docs/conda-environment.yml

.travis.yml

@@ -1,9 +1,18 @@
 language: python
-dist: focal
+
+before_install:
+  # Install conda
+  - export MINICONDA=${HOME}/miniconda
+  - export PATH=${MINICONDA}/bin:${PATH}
+  - wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
+  - bash miniconda.sh -b -f -p ${MINICONDA}
+  - conda config --set always_yes yes
+  - conda config --add channels defaults
+  - conda config --add channels conda-forge
 
 install:
-  - sudo apt-get update && sudo apt-get install -y libisal-dev
-  - pip install tox
+  - conda create -n python-isal python=$TRAVIS_PYTHON_VERSION tox isa-l
+  - source activate python-isal
 
 python: 3.6  # Use the oldest supported version of python as default.
 script:

CHANGELOG.rst

@@ -9,6 +9,7 @@ Changelog
 
 version 0.1.0-dev
 -----------------
++ Publish API documentation on readthedocs.
 + Add API documentation.
 + Ensure the igzip module is fully compatible with the gzip stdlib module.
 + Add compliance tests from CPython to ensure isal_zlib and igzip are validated

README.rst

@@ -1,3 +1,8 @@
+.. image:: https://readthedocs.org/projects/python-isal/badge
+   :target: https://python-isal.readthedocs.io
+   :alt:
+
+
 python-isal
 ===========
 
@@ -48,6 +53,9 @@ They can be imported as follows
 their api and functions are the same as the stdlib's modules. Except where
 isa-l does not support the same calls as zlib (See differences below).
 
+A full API documentation can be found on `our readthedocs page
+<https://python-isal.readthedocs.io>`_.
+
 ``python -m isal.igzip`` implements a simple gzip-like command line
 application (just like ``python -m gzip``).
 

docs/conda-environment.yml

@@ -0,0 +1,9 @@
+name: rtd
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - isa-l
+  - python >=3.6
+  - sphinx
+  - setuptools

setup.py

@@ -19,6 +19,7 @@
 # SOFTWARE.
 
 import os
+import sys
 from pathlib import Path
 
 from setuptools import Extension, find_packages, setup
@@ -29,6 +30,9 @@
 CONDA_PREFIX = os.environ.get("CONDA_PREFIX")
 if CONDA_PREFIX:
     EXTENSION_OPTS["include_dirs"] = [os.path.join(CONDA_PREFIX, "include")]
+if os.environ.get("READTHEDOCS"):
+    # Readthedocs uses a conda environment but does not activate it.
+    EXTENSION_OPTS["include_dirs"] = [os.path.join(sys.exec_prefix, "include")]
 
 setup(
     name="isal",