Msprime: [Docs] Add initial table of functions/classes to Python API section

Created on 7 May 2020  路  3Comments  路  Source: tskit-dev/msprime

Inspired by the Python docs, make some sort of table, short subsection listing the various functions and classes by usage. For example, all the Demographic events should be grouped together, and all the different simulation model classes grouped together.

Not sure how these can be best displayed, but the idea is to provide a single place where the user can see all the available functions and classes and where they can click on a link to get the precise documentation.

Most helpful comment

This should be closed by the new quickref section. Any objections?

All 3 comments

This should be closed by the new quickref section. Any objections?

I think this can be closed. I think the table looks good.
But, will all the functions be linked in the docs? Some of them are linked now and some aren't. I assume that's just because not all the docs are complete yet.

OK, thanks @agladstein.

All the documented functions will be in the docs - not everything is part of the public API that we want to support. The top-level summary table should contain all the functions though, I think.

Closing this for now anyway, as the high-level point has been fixed.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

eldonb picture eldonb  路  5Comments

ismael-mendoza picture ismael-mendoza  路  7Comments

jeromekelleher picture jeromekelleher  路  5Comments

jeromekelleher picture jeromekelleher  路  4Comments

petrelharp picture petrelharp  路  8Comments