Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace setuptools command to build manpages #758

Open
mih opened this issue Sep 21, 2024 · 0 comments
Open

Replace setuptools command to build manpages #758

mih opened this issue Sep 21, 2024 · 0 comments

Comments

@mih
Copy link
Member

mih commented Sep 21, 2024

#752 transitions away from setuptools.

This requires a new approach to build the manpages as part of the release/installation process.

Initially, I thought this could be a hatch build hook: https://hatch.pypa.io/latest/plugins/build-hook/custom/

However, of the two manpage flavors we have, we need one for building the docs, and one to install on systems that can handle manpages.

One could argue that it should be the task of a CLI package to provide this functionality. Thinking more, I believe that it cannot be anywhere other than in a CLI package, because the CLI interface will depend on the CLI frontend. Generating manpages in library packages requires either to make assumptions about what a CLI does and supports. This should be avoided.

Actual generation should be factored out of the setuptools framework and into a script that can handle the command suite entrypoints directly -- this is what is happening inside.

Given all requirements, the seemingly only approach is to generate manpage on-demand (either in user-space or in a package's post-install hook).

@mih mih mentioned this issue Sep 21, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant