Generate CLI documentation files?

[victorlin]

Doc updates such as #1523 are tedious and prone to human error. It would be good if they can be auto-generated.

API docs can already be auto-generated, #1525 adds that to CI.

[victorlin]

I don't think this is trivial since some doc files e.g. augur traits have custom text that isn't possible with auto-generation. If they were moved to docstrings such as distance.py it might be possible.

[joverlee521]

I don't think this is trivial since some doc files e.g. augur traits have custom text that isn't possible with auto-generation.

Following the dev docs, I thought the doc files were auto-generated with

sphinx-apidoc -T -f -MeT -o docs/api augur

Then any custom text is added manually?

We can at least run the sphinx-apidoc command to autogenerate the pages and they can get manually filled in with custom text as needed?

[victorlin]

Oh... I completely missed that section of dev docs 🤦 this person needs to read more

[victorlin]

I created this before realizing API docs could be regenerated but this still applies to CLI docs. Closing as unplanned since there is no obvious solution and CLI docs aren't updated as frequently.