8000 feat: Add `data-skip-inventory` boolean attribute for elements to skip local inventory by johnslavik · Pull Request #774 · mkdocstrings/mkdocstrings · GitHub
[go: up one dir, main page]
Skip to content

feat: Add data-skip-inventory boolean attribute for elements to skip local inventory #774

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.

Sign up for GitHub

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

Jump to bottom
Merged
pawamoy merged 5 commits into from
Jul 21, 2025
Merged

feat: Add data-skip-inventory boolean attribute for elements to skip local inventory #774

pawamoy merged 5 commits into from
Jul 21, 2025

Conversation

@johnslavik
Copy link
Member
@johnslavik johnslavik commented Jul 13, 2025 •
edited
Loading

Closes #671

@johnslavik johnslavik requested a review from Copilot July 13, 2025 16:20

This comment was marked as outdated.

Sign in to view

@johnslavik
Copy link
Member Author
johnslavik commented Jul 13, 2025 •
edited
Loading

Great, tests broke with default skip_inventory=True as expected :-)
@johnslavik
Copy link
Member Author
johnslavik commented Jul 13, 2025 •
edited
Loading

The initial suggestion was that we would use a data-inventory attribute and decide about registering based on that.

However, that has approach 2 problems:

  • It doesn't conform to the HTML standard on boolean attributes (https://html.spec.whatwg.org/#boolean-attributes)
  • It creates more friction, as now all elements that are automatically registered (which is the vast majority) will have data-inventory="true" and _process_headings would have to treat (1) no presence of data-inventory and (2) presence with a truthy value (which requires a new convention, because it's string checking; like: is data-skip-inventory="n" a truthy or falsey value?) as the same flag. I don't like that.

Therefore, I suggest that we only add data-skip-inventory to all excluded elements. It will treat any presence of data-skip-inventory as the intent to skip the inventory, so all elements from

<h1 data-skip-inventory></h1>
<h1 data-skip-inventory=""></h1>
<h1 data-skip-inventory="true"></h1>
<h1 data-skip-inventory="false"></h1>  <!-- sic -->

would be treated as excluded from registration in the inventory, and only elements without the presence of data-skip-inventory would be registered.

@johnslavik johnslavik linked an issue Jul 13, 2025 that may be closed by this pull request
feature: No-inventory YAML option #671
Closed
@johnslavik johnslavik changed the title feat: Add flag for elements to skip inventory feat: Add data-skip-inventory boolean attribute for elements to skip local inventory Jul 13, 2025
@johnslavik johnslavik mentioned this pull request Jul 13, 2025
Merged
@johnslavik
Copy link
Member Author
johnslavik commented Jul 13, 2025 •
edited
Loading

Check https://smokeshow.helpmanual.io/0a4t3q1d6l2f062y3b67/usage/configuration/headings/#skip_local_inventory from mkdocstrings/python#297 to see how this works in practice :)

@pawamoy
Copy link
Member
pawamoy commented Jul 14, 2025

Thanks for the analysis and taking the right direction! Also, clever example in the docs!

@johnslavik johnslavik marked this pull request as ready for review July 16, 2025 06:16
@johnslavik johnslavik requested a review from pawamoy July 16, 2025 06:16
pawamoy
pawamoy reviewed Jul 21, 2025
View reviewed changes
johnslavik and others added 2 commits July 21, 2025 16:41
@johnslavik @pawamoy
Use presence check instead of value check
787f0b5 
Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>
@johnslavik @pawamoy
Prettify do_heading param docstring
fa03b47 
Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>
pawamoy
pawamoy approved these changes Jul 21, 2025
View reviewed changes
Copy link
Member
@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

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

OK LGTM, thanks a lot!

8E5B @pawamoy pawamoy merged commit f856160 into main Jul 21, 2025
53 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@pawamoy pawamoy pawamoy approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

feature: No-inventory YAML option

3 participants

@johnslavik @pawamoy
0