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

DOC: Link to custom CSS example broken #2023

Closed
pllim opened this issue Oct 29, 2024 · 2 comments · Fixed by #2025
Closed

DOC: Link to custom CSS example broken #2023

pllim opened this issue Oct 29, 2024 · 2 comments · Fixed by #2025
Labels
good first issue Good for newcomers kind: documentation Improvements or additions to documentation tag: CI Pull requests that update GitHub Actions code
Milestone
0.16.1

Comments

@pllim
Copy link
Contributor

pllim commented Oct 29, 2024 •
edited
Loading

On page https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/web-components.html , "custom CSS file" that points to https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/custom-css gives a 404

"CSS custom properties" that points to https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/css-variables is also broken.

p.s. Maybe running Sphinx linkcheck could catch some of these ❓

(Noticed this when investigating astropy/astropy#15112 )
@drammock drammock added good first issue Good for newcomers kind: documentation Improvements or additions to documentation tag: CI Pull requests that update GitHub Actions code labels Oct 29, 2024
@drammock
Copy link
Collaborator

"custom CSS file" probably meant to go here: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/static_assets.html

"css custom properties" probably meant to go here: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/styling.html#css-theme-variables

also would gladly review/merge addition of linkcheck to our CIs.

@pllim pllim mentioned this issue Oct 30, 2024
Merged
@pllim
Copy link
Contributor Author

pllim commented Oct 30, 2024

#2025 would fix the immediate breakage.

As for linkcheck, maybe I misspoke. I realized now it is intersphinx, not direct URL, so maybe what you need is something like #2026

drammock pushed a commit that referenced this issue Oct 30, 2024
@pllim
DOC: Fix link to custom CSS example (#2025)
eef44a2 
As pointed out in
#2023 (comment)

Fix #2023
@Carreau Carreau added this to the 0.16.1 milestone Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers kind: documentation Improvements or additions to documentation tag: CI Pull requests that update GitHub Actions code
Projects
None yet
Milestone
0.16.1
Development

Successfully merging a pull request may close this issue.

DOC: Fix link to custom CSS example pllim/pydata-sphinx-theme
3 participants
@Carreau @drammock @pllim