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.

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

CI: Add a warning banner on doc previews #406

Closed
leofang opened this issue Jan 16, 2025 · 1 comment · Fixed by #410
Closed

CI: Add a warning banner on doc previews #406

leofang opened this issue Jan 16, 2025 · 1 comment · Fixed by #410
Assignees
@leofang
Labels
CI/CD CI/CD infrastructure documentation Improvements or additions to documentation P1 Medium priority - Should do
Milestone
cuda-python 12-ne...

Comments

@leofang
Copy link
Member

leofang commented Jan 16, 2025

We introduced a doc preview CI in #380. A follow-up work needed is to find a magical way (perhaps through the Sphinx theme in use) to generate a warning banner to remind readers that they are not production-ready docs, only for preview purposes. Then we turn this on in the CI.
@leofang leofang added CI/CD CI/CD infrastructure documentation Improvements or additions to documentation P1 Medium priority - Should do triage Needs the team's attention labels Jan 16, 2025
@leofang
Copy link
Member Author

leofang commented Jan 19, 2025

xref: https://pradyunsg.me/furo/customisation/announcement/

@leofang leofang mentioned this issue Jan 19, 2025
Merged
@leofang leofang self-assigned this Jan 19, 2025
@leofang leofang removed the triage Needs the team's attention label Jan 19, 2025
@leofang leofang added this to the cuda-python 12-next, 11-next milestone Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@leofang leofang

Labels
CI/CD CI/CD infrastructure documentation Improvements or additions to documentation P1 Medium priority - Should do
Projects
None yet
Milestone
cuda-python 12-next, 11-next
Development

Successfully merging a pull request may close this issue.

CI: add a warning banner to the preview docs leofang/cuda-python
1 participant
@leofang