Skip to content

Commit

Permalink
DOC: fix indention in CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw committed Jul 25, 2023
1 parent 6d52bb4 commit 06ca7fd
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ 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/audeering/audmath/
cd audmath
# Create virtual environment for this project
# e.g.
# virtualenv --python="python3" $HOME/.envs/audmath
# source $HOME/.envs/audmath/bin/activate
pip install -r requirements.txt
git clone https://github.com/audeering/audmath/
cd audmath
# Create virtual environment for this project
# e.g.
# virtualenv --python="python3" $HOME/.envs/audmath
# source $HOME/.envs/audmath/bin/activate
pip install -r requirements.txt


This way,
Expand Down Expand Up @@ -83,18 +83,18 @@ 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 docs/requirements.txt
pip install -r docs/requirements.txt

To create the HTML pages, use::

python -m sphinx docs/ build/sphinx/html -b html
python -m sphinx docs/ build/sphinx/html -b html

The generated files will be available
in the directory :file:`build/sphinx/html/`.

It is also possible to automatically check if all links are still valid::

python -m sphinx docs/ build/sphinx/html -b linkcheck
python -m sphinx docs/ build/sphinx/html -b linkcheck

.. _Sphinx: http://sphinx-doc.org

Expand All @@ -105,11 +105,11 @@ Running the Tests
You'll need pytest_ for that.
It can be installed with::

pip install -r tests/requirements.txt
pip install -r tests/requirements.txt

To execute the tests, simply run::

python -m pytest
python -m pytest

.. _pytest: https://pytest.org

Expand Down

0 comments on commit 06ca7fd

Please sign in to comment.