GeneticTree icon indicating copy to clipboard operation
GeneticTree copied to clipboard

Create documentation

Open ErdaradunGaztea opened this issue 4 years ago • 1 comments

Having a documentation for this package would make for an easier introduction for newcomers. Especially some example usages and quick start guides.

ErdaradunGaztea avatar Dec 07 '20 09:12 ErdaradunGaztea

Now the package is before first release but later we are planning to create documentation as a webpage. If you prefer to see high level code (now we don't have usage examples) as webpage you can compile current documentation on your own computer. You have to go to doc directory and run 'make html'. Before you have to create python environment with packages in requirements_dev.txt.

MakowToms avatar Dec 08 '20 01:12 MakowToms