Skip to content

Generate documentation redirects for lowercase rule codes - #15564

Merged
dhruvmanila merged 3 commits into
astral-sh:mainfrom
InSyncWithFoo:docs-redirects
Jan 18, 2025
Merged

Generate documentation redirects for lowercase rule codes#15564
dhruvmanila merged 3 commits into
astral-sh:mainfrom
InSyncWithFoo:docs-redirects

Conversation

@InSyncWithFoo

@InSyncWithFoo InSyncWithFoo commented Jan 18, 2025

Copy link
Copy Markdown
Contributor

Summary

Resolves #15016.

Test Plan

None.

charliermarsh
charliermarsh approved these changes Jan 18, 2025
View reviewed changes

@charliermarsh charliermarsh left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks.

@InSyncWithFoo

InSyncWithFoo commented Jan 18, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

I couldn't actually verify if this works locally (even before the change), but theoretically it should.

@github-actions

github-actions Bot commented Jan 18, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

Formatter (stable)

ℹ️ ecosystem check encountered format errors. (no format changes; 1 project error)

openai/openai-cookbook (error) 

warning: Detected debug build without --no-cache.
error: Failed to read examples/Assistants_API_overview_python.ipynb: Expected a Jupyter Notebook, which must be internally stored as JSON, but this file isn't valid JSON: expected `,` or `]` at line 197 column 8

Formatter (preview)

ℹ️ ecosystem check encountered format errors. (no format changes; 1 project error)

openai/openai-cookbook (error) 

ruff format --preview

warning: Detected debug build without --no-cache.
error: Failed to read examples/Assistants_API_overview_python.ipynb: Expected a Jupyter Notebook, which must be internally stored as JSON, but this file isn't valid JSON: expected `,` or `]` at line 197 column 8

dhruvmanila
dhruvmanila approved these changes Jan 18, 2025
View reviewed changes

@dhruvmanila dhruvmanila left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

I tested it out locally using by generating the docs using:

uv run --with-requirements docs/requirements-insiders.txt scripts/generate_mkdocs.py

and, checking whether the mapping was created in mkdocs.generated.yml and running the server using:

uvx --with-requirements docs/requirements-insiders.txt -- mkdocs serve -f mkdocs.insiders.yml -o

@dhruvmanila dhruvmanila added the documentation Improvements or additions to public-facing documentation label Jan 18, 2025
@dhruvmanila
dhruvmanila merged commit 9730ff3 into astral-sh:main Jan 18, 2025
@InSyncWithFoo
InSyncWithFoo deleted the docs-redirects branch January 18, 2025 05:15
@BrewTestBot BrewTestBot mentioned this pull request Jan 23, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@charliermarsh charliermarsh charliermarsh approved these changes
@dhruvmanila dhruvmanila dhruvmanila approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to public-facing documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Rule documentation link does not work with lower case code

3 participants

@InSyncWithFoo @charliermarsh @dhruvmanila