Build man pages for the CLI

[Cadair]

Maybe with sphinx?

[neelakantan-ca]

Hi, I'm new to Github and would like to contribute

I think I can make a man page for parfive, should I just fork the repo, create a man page and add it to the root of the repo ?

[Cadair]

Hello @Cantej 👋

My thoughts here are that I would like to have more detailed info available primarily to people who want to use the CLI. Given our documentation is built using sphinx, which already contains some information on the CLI, and any new information we put in the man pages should be available in the web docs as well. I was planning on using sphinx's man page output generator.

From a quick look over sphinx's manual page options it looks like you can select a subtree of your docs to be the man page(s), so maybe the best flow here would be:

1. Make a new rst file in the docs folder dedicated to the CLI.
2. Write the kind of things you would expect in a man page detailing the CLI options etc.
3. Test using sphinx with the man page builder to build a man page in the format expected.

Let us know if you have any questions, and feel free to write as much or as little in the documentation as you want, getting the infrastructure working would be a great contribution in itself.

[neelakantan-ca]

Hi,

I may not actually be able to do this, if someone else would like to take this up, please feel free

[exitflynn]

i'm looking into this! 🤠

edit: i dont think id be able to work on this in the near future, please feel free to work on it