Repository navigation
[pyos] Broken link in docs #396
Description
On https://python-graphblas.readthedocs.io/en/latest/user_guide/fundamentals.html, the graphblas.org link is broken, probably due to a double-: in https:://graphblas.org
On https://python-graphblas.readthedocs.io/en/latest/user_guide/fundamentals.html, the graphblas.org link is broken, probably due to a double-: in https:://graphblas.org
Activity
Update fundamentals.rst
Update fundamentals.rst (#397)
eriknw commentedon Mar 7, 2023
Thanks for the report @szhorvat and the fix @SultanOrazbayev! ❤️
szhorvat commentedon Mar 7, 2023
I won't open a separate issue for this, as it's not a big deal, but the doc page doesn't look great in dark mode, and the header image just went missing. I think it was there earlier today.
Of course this is not particularly relevant for the review, I'm just pointing out things as I see them.
eriknw commentedon Mar 8, 2023
Thanks for reporting. I fixed the header logo in #400. I think this just happened.
As for not looking good in dark mode, the "stable" build of the docs looks fine to me:
https://python-graphblas.readthedocs.io/en/stable/index.html
The stable build uses
pydata-sphinx-theme0.12.0. The "latest" build uses version 0.13.1. Looks like something changed (CC @jim22k). Perhaps we should pin to a specific version.Also, should we point to "stable" docs instead of "latest" docs? As a developer, it's nice to have issues reported for latest.
Regarding the original issue of a broken link in the doc, perhaps we should add a check to ensure links work. For example,
make linkcheckmostly does this, but seems to have issues for relative links for me.SultanOrazbayev commentedon Mar 8, 2023
Just a quick note to confirm the docs render well for me in the dark mode also and I can see the logo.
jim22k commentedon Mar 8, 2023
I just updated readthedocs config so that "stable" is the default.
@eriknw I'll update your PR with a fix for the dark mode.