chore: Docs/update links #2329
chore: Docs/update links #2329
Conversation
|
@RobertRosca is this ready? I see it is in draft status but looks mostly done |
|
About your comments on the comma separated issue links in the changelog: I think I know what's going on since I ran into this when checking the docs locally. The URL for 'Releae notes/changelog' is hardcoded to https://docs.litestar.dev/2/release-notes/changelog.html, so when you click it even in the preview/locally built docs it takes you to the page for the current deployed documentation, not the preview. The formatting/incorrect links you pointed out are the ones I fixed with those changes, you can see the preview page for the changelog here: https://litestar-org.github.io/litestar-docs-preview/2329/release-notes/changelog.html Current docs:
Preview docs:
|
using linkcheck with pydata_sphinx_theme leads to a build error, moved theme setup into `delayed_setup` function
Co-authored-by: Jacob Coffee <jacob@z7x.org>
references to docs in `seealso` are always lists Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
many falso positives
provinzkraut
force-pushed
the
docs/update-links
branch
from
d737344
to
6e47164
Compare
|
@all-contributors add @RobertRosca for docs |
|
I've put up a pull request to add @RobertRosca! 🎉 |
|
@RobertRosca Thanks, this is quite helpful (= |
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/2329 |
Pull Request Checklist
Description
Ran across a few broken links in the documentation. This PR:
There was an issue running linkcheck with the pydata theme, so I had to add in a mildly awkward workaround to disable the theme when linkcheck is running.
The full check is not used in any CIs, but it could be set to be manually triggered or to only run on merges to main.
There are a few invalid-ish external links (mostly anchor issues) which I haven't fixed yet, which is why this is a draft PR.done