Home

datavis

datavis is a visualization library for scientific data analysis.

Releasing

Create the package to upload to PyPI:

$ python setup.py sdist
$ python -m twine upload dist/*

Building documentation

We use Sphinx with ReadTheDocs theme for generating the documentation. We use sphinx.autodoc extension for generating the documentation from modules, classes, and methods. We also use the sphinx.napoleon extension to use the Google Style for Python.

Useful links:

• Sphinx Primer: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
• Google Style for Python: http://google.github.io/styleguide/pyguide.html

Generating the docs

Cloned environment pwPy37 (Python 7 with emcore, emvis, datavis and pyworkflow)

$ conda create --clone pwPy37 --name pwPy37-docs
$ conda activate pwPy37-docs
$ pip install sphinx sphinx_rtd_theme sphinxcontrib-napoleon

$ cd docs
$ make html

Main html is in _build/html/index.html

Nice tutorial at: https://sphinx-tutorial.readthedocs.io Another tutorial: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/index.html