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

Use MkDocs' not_in_nav #5498

Merged
merged 4 commits into from Sep 19, 2023
Merged

Conversation

MicaelJarniac
Copy link
Contributor

@MicaelJarniac MicaelJarniac commented Jul 4, 2023

Closes #5497
Needs MkDocs 1.5 to be released.

Summary

Uses MkDocs' not_in_nav config to hide spam about files in docs/rules/ not being in nav.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 4, 2023

PR Check Results

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00     10.5±0.34ms     3.9 MB/sec    1.01     10.6±0.37ms     3.8 MB/sec
formatter/numpy/ctypeslib.py               1.00      2.1±0.07ms     8.1 MB/sec    1.02      2.1±0.13ms     7.9 MB/sec
formatter/numpy/globals.py                 1.00   241.4±10.79µs    12.2 MB/sec    1.04   251.6±21.45µs    11.7 MB/sec
formatter/pydantic/types.py                1.01      4.6±0.16ms     5.5 MB/sec    1.00      4.6±0.21ms     5.6 MB/sec
linter/all-rules/large/dataset.py          1.00     15.9±0.49ms     2.6 MB/sec    1.00     15.9±0.59ms     2.6 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.9±0.16ms     4.2 MB/sec    1.03      4.1±0.14ms     4.1 MB/sec
linter/all-rules/numpy/globals.py          1.00   524.9±26.59µs     5.6 MB/sec    1.06   554.9±26.06µs     5.3 MB/sec
linter/all-rules/pydantic/types.py         1.00      7.1±0.24ms     3.6 MB/sec    1.03      7.3±0.29ms     3.5 MB/sec
linter/default-rules/large/dataset.py      1.00      7.7±0.23ms     5.3 MB/sec    1.02      7.8±0.20ms     5.2 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00  1685.0±71.24µs     9.9 MB/sec    1.01  1708.8±49.97µs     9.7 MB/sec
linter/default-rules/numpy/globals.py      1.02   207.6±10.25µs    14.2 MB/sec    1.00   204.3±10.91µs    14.4 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.5±0.13ms     7.3 MB/sec    1.00      3.5±0.12ms     7.3 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00     13.3±0.63ms     3.1 MB/sec    1.00     13.3±0.76ms     3.1 MB/sec
formatter/numpy/ctypeslib.py               1.00      2.5±0.13ms     6.8 MB/sec    1.02      2.5±0.14ms     6.7 MB/sec
formatter/numpy/globals.py                 1.00   281.1±17.63µs    10.5 MB/sec    1.03   290.4±16.72µs    10.2 MB/sec
formatter/pydantic/types.py                1.00      5.3±0.24ms     4.8 MB/sec    1.05      5.5±0.29ms     4.6 MB/sec
linter/all-rules/large/dataset.py          1.00     18.7±1.01ms     2.2 MB/sec    1.03     19.3±0.98ms     2.1 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.03      5.0±0.22ms     3.3 MB/sec    1.00      4.8±0.17ms     3.4 MB/sec
linter/all-rules/numpy/globals.py          1.03   620.3±21.32µs     4.8 MB/sec    1.00   603.4±31.44µs     4.9 MB/sec
linter/all-rules/pydantic/types.py         1.11      9.2±0.33ms     2.8 MB/sec    1.00      8.2±0.40ms     3.1 MB/sec
linter/default-rules/large/dataset.py      1.07      9.9±0.23ms     4.1 MB/sec    1.00      9.2±0.47ms     4.4 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.06      2.1±0.05ms     8.0 MB/sec    1.00  1975.8±108.14µs     8.4 MB/sec
linter/default-rules/numpy/globals.py      1.01    242.8±8.93µs    12.2 MB/sec    1.00   241.0±15.92µs    12.2 MB/sec
linter/default-rules/pydantic/types.py     1.00      4.2±0.28ms     6.0 MB/sec    1.01      4.3±0.25ms     6.0 MB/sec

@JonathanPlasse
Copy link
Contributor

MkDocs 1.5 has been released.

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Sep 18, 2023
@charliermarsh charliermarsh marked this pull request as ready for review September 18, 2023 23:51
@charliermarsh
Copy link
Member

Thank you! Just merged, updated, and fixed some other warnings.

@charliermarsh charliermarsh enabled auto-merge (squash) September 18, 2023 23:59
@charliermarsh charliermarsh merged commit 40f6456 into astral-sh:main Sep 19, 2023
15 checks passed
@MicaelJarniac MicaelJarniac deleted the not_in_nav branch September 19, 2023 12:29
renovate bot added a commit to allenporter/flux-local that referenced this pull request Sep 24, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [ruff](https://docs.astral.sh/ruff)
([source](https://togithub.com/astral-sh/ruff),
[changelog](https://togithub.com/astral-sh/ruff/releases)) | `==0.0.290`
-> `==0.0.291` |
[![age](https://developer.mend.io/api/mc/badges/age/pypi/ruff/0.0.291?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/ruff/0.0.291?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/ruff/0.0.290/0.0.291?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/ruff/0.0.290/0.0.291?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>astral-sh/ruff (ruff)</summary>

###
[`v0.0.291`](https://togithub.com/astral-sh/ruff/releases/tag/v0.0.291)

[Compare
Source](https://togithub.com/astral-sh/ruff/compare/v0.0.290...v0.0.291)

<!-- Release notes generated using configuration in .github/release.yml
at v0.0.291 -->

#### What's Changed

##### Deprecations

**The `format` command-line argument and configuration option has been
renamed to `output-format`.** While Ruff will continue to respect
`format` when passed as a command-line argument or configuration option,
this backwards-compatible support will be dropped in a future release.
See:
[astral-sh/ruff#7514.

##### Rules

- \[`flake8-bandit`] Implement `S201`: `flask-debug-true` by
[@&#8203;mkniewallner](https://togithub.com/mkniewallner) in
[astral-sh/ruff#7503
- \[`flake8-bandit`] Implement `S507`: `ssh_no_host_key_verification` by
[@&#8203;mkniewallner](https://togithub.com/mkniewallner) in
[astral-sh/ruff#7528
- \[`flake8-logging`] Implement `LOG002`: `invalid-get-logger-argument`
by [@&#8203;dhruvmanila](https://togithub.com/dhruvmanila) in
[astral-sh/ruff#7399
- \[`flake8-logging`] Implement `LOG007`: `exception-without-exc-info`
by [@&#8203;qdegraaf](https://togithub.com/qdegraaf) in
[astral-sh/ruff#7410
- \[`refurb`] Implement `FURB140`: `reimplemented-starmap` by
[@&#8203;SavchenkoValeriy](https://togithub.com/SavchenkoValeriy) in
[astral-sh/ruff#7253
- \[`refurb`] Implement `FURB148`: `unnecessary-enumerate` by
[@&#8203;tjkuson](https://togithub.com/tjkuson) in
[astral-sh/ruff#7454
- \[`ruff`] Detect `asyncio.get_running_loop` calls in RUF006 by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7562

##### Settings

- Show `--no-X` variants in CLI help by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7504
- Rename `format` option to `output-format` by
[@&#8203;MichaReiser](https://togithub.com/MichaReiser) in
[astral-sh/ruff#7514
- Enable tab completion for `ruff rule` by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7560

##### Bug Fixes

- Add padding to prevent some autofix errors by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7461
- Remove parentheses when rewriting assert calls to statements by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7464
- Avoid flagging starred elements in C402 by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7466
- Extend `bad-dunder-method-name` to permit `attrs` dunders by
[@&#8203;tjkuson](https://togithub.com/tjkuson) in
[astral-sh/ruff#7472
- Avoid N802 violations for
[@&#8203;overload](https://togithub.com/overload) methods by
[@&#8203;JonathanPlasse](https://togithub.com/JonathanPlasse) in
[astral-sh/ruff#7498
- Avoid flagging starred expressions in UP007 by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7505
- Ensure that LOG007 only triggers on `.exception()` calls by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7524
- Use strict sorted and union for NoQA mapping insertion by
[@&#8203;dhruvmanila](https://togithub.com/dhruvmanila) in
[astral-sh/ruff#7531
- Avoid inserting imports directly after continuation by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7553
- Add padding in `PERF102` fixes by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7554
- Avoid invalid fix for parenthesized values in F601 by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7559
- Treat `os.error` as an `OSError` alias by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[astral-sh/ruff#7582
- Extend `bad-dunder-method-name` to permit `__html__` by
[@&#8203;jaap3](https://togithub.com/jaap3) in
[astral-sh/ruff#7492
- Fix stylist indentation with a formfeed by
[@&#8203;konstin](https://togithub.com/konstin) in
[astral-sh/ruff#7489

#### New Contributors

- [@&#8203;MicaelJarniac](https://togithub.com/MicaelJarniac) made their
first contribution in
[astral-sh/ruff#5498
- [@&#8203;maheshsaripalli9](https://togithub.com/maheshsaripalli9) made
their first contribution in
[astral-sh/ruff#7552
- [@&#8203;T-256](https://togithub.com/T-256) made their first
contribution in
[astral-sh/ruff#7585

**Full Changelog**:
astral-sh/ruff@v0.0.290...v0.0.291

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/allenporter/flux-local).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi45Ny4xIiwidXBkYXRlZEluVmVyIjoiMzYuOTcuMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use MkDocs not_in_nav to hide huge list of docs/rules/ files
3 participants