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

Generate documentation redirects for lowercase rule codes #15564

Merged
merged 3 commits into from
Jan 18, 2025

Conversation

InSyncWithFoo
Copy link
Contributor

Summary

Resolves #15016.

Test Plan

None.

Copy link
Member

@charliermarsh charliermarsh left a comment

Choose a reason for hiding this comment

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

Thanks.

@InSyncWithFoo
Copy link
Contributor Author

InSyncWithFoo commented Jan 18, 2025

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

Copy link
Contributor

github-actions bot commented Jan 18, 2025

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

Copy link
Member

@dhruvmanila dhruvmanila left a comment

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 documentation label Jan 18, 2025
@dhruvmanila dhruvmanila merged commit 9730ff3 into astral-sh:main Jan 18, 2025
21 checks passed
@InSyncWithFoo InSyncWithFoo deleted the docs-redirects branch January 18, 2025 05:15
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.

Rule documentation link does not work with lower case code
3 participants