giuliano-macedo / clusopt_core

Clustream, Streamkm++ and metrics utilities C/C++ bindings for python
GNU General Public License v3.0
15 stars 1 forks source link

Docs #1

Open giuliano-macedo opened 3 years ago

giuliano-macedo commented 3 years ago

Mostly of the code have google styled docstrings, however i haven't setup any documentation program like sphynx.

adhistac commented 3 years ago

To install sphinx enter the command pip install sphinx in the terminal. To get started with sphinx, first, build a folder and enter sphinx-quickstart in the terminal, fill in the details, you are good to go.