================= README for Sphinx ================= This is the Sphinx documentation generator, see Installing ========== Use ````:: python build sudo python install Reading the docs ================ After installing:: cd doc make html Then, direct your browser to ``_build/html/index.html``. Or read them online at <>. Testing ======= To run the tests with the interpreter available as ``python``, use:: make test If you want to use a different interpreter, e.g. ``python3``, use:: PYTHON=python3 make test Continuous testing runs on .. image:: :target: Contributing ============ #. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There are Non Assigned issues: #. If you feel uncomfortable or uncertain about an issue or your changes, feel free to email #. Fork the repository on Bitbucket to start making your changes to the **default** branch for next major version, or **stable** branch for next minor version. #. Write a test which shows that the bug was fixed or that the feature works as expected. #. Send a pull request and bug the maintainer until it gets merged and published. Make sure to add yourself to AUTHORS <> and the change to CHANGES <>.