DevelopersGuide.txt

Before a big commit.
(we need to make the tests!!!)

- Check all notebooks work fine
- Check that requirements has all the necessary libraries. Otherwise readmydocs may not produce the code tab
- run update_doc_elements.sh to update the Shpinx tutorial notebooks
- if you add some math to the notebooks probably you have to go afterwards to the rst and change the latex enviroment
  to ..math:
- Then you can build or not the html to check offline if everything is in order
- Push and check that readmydocs just worked fine

# set version number in setup.py, both for version and in download_url, also in the config file of the documentation
version='X.X',
download_url='https://github.com/cgre-aachen/gempy/archive/X.X.tar.gz',
# add new tag
$ git tag X.X -m "Add X.X tag for PyPI"
# push git tag
$ git push --tags origin master
# upload newest version to PyPi
#  First create the dist
python3 setup.py sdist bdist_wheel

# Second upload the distributions
twine upload dist/*



### Type of commits:

ENH: Enhancement, new functionality
BUG: Bug fix
DOC: Additions/updates to documentation
TST: Additions/updates to tests
BLD: Updates to the build process/scripts
PERF: Performance improvement
CLN: Code cleanup