Merge pull request #204 from pycompression/builddetails

Add a development chapter

Author: rhpvorderman

.github/workflows/ci.yml

@@ -2,9 +2,6 @@ name: Continous integration
 
 on:
   pull_request:
-    paths-ignore:
-      - 'docs/**'
-      - '*.rst'
   push:
     branches:
       - develop

README.rst

@@ -166,6 +166,24 @@ are also very welcome. Please report them on the `github issue tracker
 
 .. contributing end
 
+Development
+-----------
+.. development start
+
+The repository needs to be cloned recursively to make sure the
+`ISA-L <https://github.com/intel/isa-l>`_ repository is checked out:
+``git clone --recursive https://github.com/pycompression/python-isal.git``. If
+the repository is already checked out you can use ``git submodule update --init``.
+
+Patches should be made on a feature branch. To run the testing install ``tox``
+with ``pip install tox`` and run the commands ``tox -e lint`` and
+``tox``. That will run most of the testing that is also performed by the CI.
+For changes to the documentation run ``tox -e docs``. For changes to the C
+code please also run ``tox -e asan`` to check for memory leaks. This requires
+libasan to be installed.
+
+.. development end
+
 Acknowledgements
 ----------------
 

docs/conf.py

@@ -4,27 +4,20 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-from distutils.dist import DistributionMetadata
-from pathlib import Path
-
-import pkg_resources
+from isal import __version__
 
 # -- Project information -----------------------------------------------------
 
 # Get package information from the installed package.
-package = pkg_resources.get_distribution("isal")
-metadata_file = Path(package.egg_info) / Path(package.PKG_INFO)
-metadata = DistributionMetadata(path=str(metadata_file))
 
 project = 'python-isal'
 copyright = '2020, Leiden University Medical Center'
 author = 'Leiden University Medical Center'
 
 # The short X.Y version
-version = package.parsed_version.base_version
+version = __version__
 # The full version, including alpha/beta/rc tags
-release = package.version
-
+release = __version__
 
 # -- General configuration ---------------------------------------------------
 

docs/index.rst

@@ -158,6 +158,13 @@ Contributing
    :start-after: .. contributing start
    :end-before: .. contributing end
 
+===========
+Development
+===========
+.. include:: includes/README.rst
+   :start-after: .. development start
+   :end-before: .. development end
+
 ================
 Acknowledgements
 ================

requirements-docs.txt

@@ -1,4 +1,4 @@
 sphinx
-setuptools
 sphinx-rtd-theme
-sphinx-argparse
+# See https://github.com/sphinx-doc/sphinx-argparse/issues/56
+sphinx-argparse <0.5.0