aws / aws/aws-cli

📚 Pre-build man pages rather than generating them on the fly

Open
#6,973 2 comments 4 reactions 0 assignees View on GitHub
feature-request p2
Dominant language
Python
Stars
17.3k
Forks
4.6k
Avg merge
1d 2h
Merged PRs (30d)
13

Description

### Describe the feature

It would be nice to have man pages pre-built instead of generating them on the fly with docutils. Take `git` as an example. All of the relevant `git` commands, like `git pull` are documented in a man page called `git-pull` and those man pages are installed alongside the package itself.

### Use Case

As an OS packager, I want pre-generated man pages so I can reduce the install requirements for `awscli` and be able to search through multiple sets of man pages for the commands and configuration I care about.

### Proposed Solution

Allow for an option (or make it default) where man pages can be generated during install/build time.

### Other Information

_No response_

### Acknowledgements

- [ ] I may be able to implement this feature request
- [ ] This feature might incur a breaking change

### CLI version used

1.24.2

### Environment details (OS name and version, etc.)

Fedora 36

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.