Developer documentation

Packages for doc:

  • pip install sphinx
  • pip install sphinx-autoapi
  • pip install sphinx_rtd_theme

To regenerate API (updated):

  • Delete contents of API folder
  • Run make clean
  • In conf.py autoapi_generate_api_docs = True
  • Run make html
  • Run hack.py
  • In conf.py: autoapi_generate_api_docs = False
  • Run make html

To regenerate API (Before):

  • uncomment line # ‘autoapi.extension’ in conf.py.
  • run make html
  • run hack.py script
  • recomment line # ‘autoapi.extension’
  • run make html
  • Eventually update project on https://readthedocs.org/projects/optimeed/

To updata packages on PyPi:

  • Change version in setup.py and in optimeed/__init__.py
  • Create new wheel file code::python setup.py sdist bdist_wheel
  • Upload it on pypi code::twine upload dist/*