DOC: Update CONTRIBUTING

And don't use "linkcheck" on Travis-CI.
This caused too many timeout errors (on valid links).

Author: mgeier

.travis.yml

@@ -12,5 +12,5 @@ install:
   - pip install -r doc/requirements.txt
 script:
   - python -m pytest
-  # This executes the example notebooks and checks for valid URLs:
-  - python -m sphinx doc/ _build/ -b linkcheck
+  # This executes the example notebooks:
+  - python -m sphinx doc/ _build/ -b dummy

CONTRIBUTING.rst

@@ -6,12 +6,15 @@ improvement, please create an issue or a pull request at
 https://github.com/sfstoolbox/sfs-python/.
 Contributions are always welcome!
 
+Development Installation
+^^^^^^^^^^^^^^^^^^^^^^^^
+
 Instead of pip-installing the latest release from PyPI, you should get the
 newest development version from Github_::
 
    git clone https://github.com/sfstoolbox/sfs-python.git
    cd sfs-python
-   python setup.py develop --user
+   python3 setup.py develop --user
 
 .. _Github: https://github.com/sfstoolbox/sfs-python/
 
@@ -20,24 +23,48 @@ changes from the Github repository.
 
 If you prefer, you can also replace the last command with::
 
-   pip install --user -e .
+   python3 -m pip install --user -e .
 
 ... where ``-e`` stands for ``--editable``.
 
+Building the Documentation
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 If you make changes to the documentation, you can re-create the HTML pages
 using Sphinx_.
 You can install it and a few other necessary packages with::
 
-   pip install -r doc/requirements.txt --user
+   python3 -m pip install -r doc/requirements.txt --user
 
 To create the HTML pages, use::
 
-   python setup.py build_sphinx
+   python3 setup.py build_sphinx
 
 The generated files will be available in the directory ``build/sphinx/html/``.
 
+It is also possible to automatically check if all links are still valid::
+
+   python3 setup.py build_sphinx -b linkcheck
+
 .. _Sphinx: http://sphinx-doc.org/
 
+Running the Tests
+^^^^^^^^^^^^^^^^^
+
+You'll need pytest_ for that.
+It can be installed with::
+
+   python3 -m pip install -r tests/requirements.txt --user
+
+To execute the tests, simply run::
+
+   python3 -m pytest
+
+.. _pytest: https://pytest.org/
+
+Creating a New Release
+^^^^^^^^^^^^^^^^^^^^^^
+
 New releases are made using the following steps:
 
 #. Bump version number in ``sfs/__init__.py``
@@ -46,7 +73,7 @@ New releases are made using the following steps:
 #. Create an (annotated) tag with ``git tag -a x.y.z``
 #. Clear the ``dist/`` directory
 #. Create a source distribution with ``python3 setup.py sdist``
-#. Create a wheel distribution with ``python3 setup.py bdist_wheel --universal``
+#. Create a wheel distribution with ``python3 setup.py bdist_wheel``
 #. Check that both files have the correct content
 #. Upload them to PyPI with twine_: ``twine upload dist/*``
 #. Push the commit and the tag to Github and `add release notes`_ containing a

doc/conf.py

@@ -45,8 +45,6 @@
 # Override kernel name to allow running with Python 2 on Travis-CI
 nbsphinx_kernel_name = 'python'
 
-linkcheck_timeout = 10
-
 autoclass_content = 'init'
 autodoc_member_order = 'bysource'
 autodoc_default_flags = ['members', 'undoc-members']