Missing docs for CLI usage

[jxltom]

It looks like I can only access the CLI usage such as options and argument via pytest --help. It will be nice to add this part to docs, so users can read it as a reference online without invoking pytest.

• Include a detailed description of the bug or suggestion
• pip list of the virtual environment you are using
• pytest and operating system versions
• Minimal example if possible

[Zac-HD]

What specifically do you want added to the usage page?

[jxltom]

It will be nice to add a full pytest CLI reference, which is a online version of pytest --help

It can be generated simply by https://github.com/click-contrib/sphinx-click.

I can try to made a PR for that, if this is reasonable.

[RonnyPfannschmidt]

@jxltom pytest does not use click however

[jxltom]

Oh, thanks for the kind reminder.

It looks like pytest using argparse? There is also a https://sphinx-argparse.readthedocs.io/en/stable/ for that. But I have never used that before. Let's give it a try...

[blueyed]

@jxltom any luck with that?
I guess it is difficult given how pytest generates the parser etc.

I guess the best would be to just have the output from --help verbatim, no? Or do you expect it to be clickable / linked to more docs?
(with regard to that I think the help should be verbose enough to not require additional docs, especially since there is no man page)

I've played a bit with https://github.com/invenia/sphinxcontrib-runcmd (and extended it already), which would allow to get pytest --helps output into a separate page, which could be linked to then.