search

lineagekit / lineagekit

A python library with genealogy methods
0 stars 0 forks source link

Decide on documentation framework #3

Closed sgravel closed 3 weeks ago

sgravel commented 1 month ago

Are we all set on automated documentation?

Serdiuk-Andrii commented 1 month ago

Explore how tskit does it

Serdiuk-Andrii commented 1 month ago

https://pystatgen.github.io/sgkit/latest/api.html

Serdiuk-Andrii commented 1 month ago

https://www.sphinx-doc.org/en/master/

shz9 commented 1 month ago

Highly recommend Mkdocs for this. Here's a tutorial for how to set it up:

https://realpython.com/python-project-documentation-with-mkdocs/

You can write your documentation in Markdown and it supports various backend / formats: sphinx, google, or numpy. Many of the popular python packages use mkdocs now.