Man pages are only generated for the first entry point

[Cynical-Optimist]

See original issue on GitLab
In GitLab by [Gitlab user @jennis] on Jan 22, 2019, 14:39

Summary

As stated in our documentation, to generate our man pages, we must execute:

python3 setup.py --command-packages=click_man.commands man_pages

However, as it currently stands, this will only generate man pages for the first entry point defined in setup.py, thus when we execute this command, we only generate the man page for bst-artifact-server.

In order to generate the man pages for all the commands defined in cli.py, we need to comment out the first entry point and then regenerate the man pages.

This is a manual cumbersome process which requires a fix upstream.

An issue has been filed upstream, here.

[Cynical-Optimist]

In GitLab by [Gitlab user @cs-shadow] on Jan 23, 2019, 17:44

Update: I made this upstream PR to fix this issue. The PR has been merged, but we are now just waiting for a release.

[Cynical-Optimist]

In GitLab by [Gitlab user @jennis] on Jan 24, 2019, 16:37

[Gitlab user @cs]-shadow, thanks for doing the upstream PR. It looks like we don't generate man pages automatically anyway (see #8), so I don't think waiting for the release concerns us, we can just close this and manually update the man pages, what do you think?

(Now that #881 has been resolved, I think this is sensible, see comment)

[Cynical-Optimist]

In GitLab by [Gitlab user @cs-shadow] on Jan 24, 2019, 17:09

I was actually planning to create a tox environment for this to make this process a bit simpler and more repeatable. That should be simple thing to do, but it would be slightly awkward to have a commit id pinned there.

I realize that it won't make it automatic, but should be better than what we have now. Does that seem reasonable?

[Cynical-Optimist]

In GitLab by [Gitlab user @jennis] on Jan 24, 2019, 17:48

Yes, I think that's a good idea. Also, no need for a commit ID, click-man has just been re-released! See: https://pypi.org/project/click-man/

Probably better for you too 'refresh' the man pages in the MR for that then?

[Cynical-Optimist]

In GitLab by [Gitlab user @cs-shadow] on Jan 24, 2019, 21:25

Sure, I have created !1107 that does both - adds a tox environment and update our man pages.

[Cynical-Optimist]

In GitLab by [Gitlab user @cs-shadow] on Jan 24, 2019, 21:27

mentioned in merge request !1107

[Cynical-Optimist]

In GitLab by [Gitlab user @tristanvb] on Jan 26, 2019, 05:10

closed via merge request !1107

[Cynical-Optimist]

In GitLab by [Gitlab user @tristanvb] on Jan 26, 2019, 05:10

mentioned in commit 222753a