Stdpopsim: Docs/API: List of CLI options

Created on 26 Nov 2019  路  4Comments  路  Source: popsim-consortium/stdpopsim

At the moment, the docs don't show users how the CLI works, or what options there are. I know @ndukler is working on a tutorial to show how some of these work in #165, but it would be good to have a list of all of the possible arguments (including all of the possible species, recombination maps, model arguments) somewhere in the docs too. Either on an API page, or elsewhere.

Subissue of #137

Most helpful comment

you are doing the lord's work here @gtsambos!

All 4 comments

you are doing the lord's work here @gtsambos!

馃懠 馃懠 馃懠

A good option here would be to use sphinx-argparse to automatically render the CLI help output in HTML. Otherwise we end up having two versions of the same docs, which inevitably drift.

A good option here would be to use sphinx-argparse to automatically render the CLI help output in HTML.

Okay, I can look into this next week. Just saw you mentioned it in #118 as well.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

grahamgower picture grahamgower  路  7Comments

jeromekelleher picture jeromekelleher  路  4Comments

David-Peede picture David-Peede  路  6Comments

agladstein picture agladstein  路  7Comments

andrewkern picture andrewkern  路  8Comments