IHEWAwapor¶
This is the documentation of IHEWAwapor.
From the root of the project, run:
python setup.py --version
Format scripts by PEP8
autopep8 –in-place –aggressive src/IHEWAwapor/WaporAPI.py
Unit test, run:
python setup.py test
Read the Docs, run:
python setup.py doctest
python setup.py docs
PyPI upload, run setup.py:
1. Commit -> Git - tag - add - v0.0.1 -> ``setup.py`` -> push
2. Github - Release - new release v0.0.1
python setup.py sdist bdist_wheel
twine check dist/*.tar.gz
twine upload dist/*
Warning
Must contain config.yml and accounts.yml-encrypted file.
Note
This is the main page of your project’s Sphinx documentation.
It is formatted in reStructuredText. Add additional pages
by creating rst-files in docs and adding them to the toctree below.
Use then references in order to link them from this page, e.g.
Authors and Changelog.
It is also possible to refer to the documentation of other Python packages
with the Python domain syntax. By default you can reference the
documentation of Sphinx, Python, NumPy, SciPy, matplotlib,
Pandas, Scikit-Learn. You can add more by extending the
intersphinx_mapping in your Sphinx’s conf.py.
The pretty useful extension autodoc is activated by default and lets you include documentation from docstrings. Docstrings can be written in Google style (recommended!), NumPy style and classical style.