.. BBKNN documentation master file, created by sphinx-quickstart on Tue Jun 19 12:04:15 2018. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Useful links: ReadTheDocs tutorial - https://docs.readthedocs.io/en/latest/getting_started.html Sphinx tutorial with example repo - https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example BBKNN ===== Project home page `here `_, tutorial notebook `here `_. Function docstrings ------------------- .. autosummary:: :toctree: bbknn.bbknn bbknn.ridge_regression bbknn.matrix.bbknn