citrine-python
Python library for the Citrine Platform
Installation
Clone from github:
git clone git@github.com:CitrineInformatics/citrine-pythonCreate a virtual environment using Python >= 3.6, and install requirements:
pip install -U -r requirements.txt
pip install -U -r test_requirements.txtDocumentation
The documentation for this project is built using Sphinx.
Building documentation
To build the documentation for this project, make sure you've installed all dependencies (core and development) using pipenv. Once done:
cd docs/
make html
You can see the result by opening docs/_build/html/index.html in a web browser.
Autogenerated docs
Sphinx supports generating documentation from docstrings, which is accomplished automatically
during the build step using sphinxcontrib-apidoc. The output of this process is stored in the gitignore'd
docs/source/reference directory. It's not stored in source control because it's generated from
the current state of the docstrings in the source code.
Custom documentation
One of the outstanding features of sphinx is its support for arbitrarily organized documentation
materials such as tutorials, introductions, and other context providing content. These items should
be stored in source control under the docs/source directory in properly formatted .rst files.