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

docs: refine docs generation script and template #1328

Merged
merged 2 commits into from
Apr 8, 2024

Conversation

huxuan
Copy link
Member

@huxuan huxuan commented Apr 7, 2024

  • I have added a news fragment under changelog.d/ (if the patch affects the end users)

Summary of changes

Fix #1325

  1. Add missing command line help, install-all, uninject, reinstall, interpreter, ensurepath, environment, completions.
  2. Order the params the same with pipx --help.
  3. Order the docs template the same with pipx --help.
  4. Remove redundant version in params.
  5. Remove {" ".join(args[2:])} which leads to redundant --help in docs.

Test plan

Docs generated from pull request: https://pipx--1328.org.readthedocs.build/1328/docs/

Tested by running

# command(s) to exercise these changes
nox -s build_docs
# or
nox -s watch_docs

Copy link
Contributor

@chrysle chrysle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thank you!

@Gitznik Gitznik merged commit 0837df2 into pypa:main Apr 8, 2024
14 checks passed
@huxuan huxuan deleted the xuan.hu/gen_docs branch April 8, 2024 07:24
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

Successfully merging this pull request may close these issues.

Reference missing command line help for various commands
3 participants