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: split options into headings #3332

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

ruben-arts
Copy link
Contributor

@ruben-arts ruben-arts commented Mar 11, 2025

Splitting the auto generated cli options into their headings.

With that I also added some extra's

  • Checking the existence of comments on the fields we generate documentation for.
  • Linting the code in CI
  • Linting the code itself.

writeln!(buffer, "- <a id=\"option-version\" href=\"#option-version\">`--version (-V)`</a>\n: Display version information").unwrap();
.into_group_map();

let sorted_header_options = header_option_map.iter().sorted_by(|a, b| {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

For reviewer:
This is the logic to make the headers seperated, and always make the Options the first, and Global Options last.

Copy link
Contributor

@Hofer-Julian Hofer-Julian 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 and works as expected.

Only had one small comment!

Comment on lines +150 to +151
# Lint pixi_docs
pixi run lint-pixi_docs
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this and the three steps above should have their own github task

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.

2 participants