docs/149-automated-doc-generation

jharwell / sierra

Automation framework for the scientific method in AI research

MIT License

18 stars 1 forks source link

docs/149-automated-doc-generation #149

Closed jharwell closed 4 years ago

jharwell commented 5 years ago

It would be extremely useful to be able to generate man pages for sierra from the argparse object used. There are ways to do this, but none of them seem to work out of the box:

argparse-manpage
sphinx (requires a bunch of setup that looks really complicated)

Would be very useful to have working...

What would be even more helpful would be to be able to generate manpages for the batch criteria, and how to format them to use correctly...

jharwell commented 4 years ago

Lots of good initial progress made on this, so I will close the issue for now, and open new ones as is necessary.