Setup
git clone https://github.com/BlueBrain/BlueBrainGraph.git
pip install --editable .[dev]
Checks before committing
tox
PEP 8, PEP 257, and PEP 20 must be followed.
# Setup
pip install --upgrade pip setuptools wheel twine
# Checkout
git checkout master
git pull upstream master
# Check
tox
# Tag
git tag -a v<x>.<y>.<z> HEAD
git push upstream v<x>.<y>.<z>
# Build
python setup.py sdist bdist_wheel
# Upload
twine upload dist/*
# Clean
rm -R build dist *.egg-info
# Install sphinx-build and related packages
pip install .[docs]
# cd to the docs directory
cd docs
# Generate the docs
sphinx-build -T -W --keep-going -b html -d _build/doctrees -c ./source -D language=en ./source _build/html