docs: fix broken links & rendering#267
Merged
leahaeusel merged 4 commits intoqueens-py:mainfrom Jan 30, 2026
Merged
Conversation
leahaeusel
force-pushed
the
fix-documentation-links
branch
2 times, most recently
from
54fb8ea to
7050a00
Compare
…fix tutorial 1 rendering
leahaeusel
force-pushed
the
fix-documentation-links
branch
from
7050a00 to
138a045
Compare
Contributor
danielwolff1
left a comment
danielwolff1
left a comment
There was a problem hiding this comment.
Thanks for fixing the broken links and improving the rendering of the documentation, looks good to me! 😊
Co-authored-by: Daniel Wolff <39346676+danielwolff1@users.noreply.github.com>
leahaeusel
force-pushed
the
fix-documentation-links
branch
from
53a8b99 to
0426578
Compare
Contributor
|
Now that I was able to build the documentation I noticed three additional small things:
However since you mostly wanted to fix the broken links introduced by #263, I guess this can also be deferred to another PR 😊 |
Member
Author
I would say this falls right into this PR's topic of fixing broken links 😉 Really nice catches, thank you for checking the links so thoroughly! |
Contributor
|
Looks good to me now, thanks for adapting this! 🎉 I guess now you just need someone to approve this 😁 |
sbrandstaeter
approved these changes
Jan 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description and Context:
What and Why?
This PR fixes some broken links in our documentation that were introduced (by me 🙈 ) in #263. To avoid this in the future, I have switched to relative links to documentation websites and added checks for wrong links by activating
nitpickyand failing on warnings (sphinx-build -W).To resolve a few legitimate warnings, I had to add first-level headers to our FAQ pages and adjust a docstring indentation in
mixture_model.py.While looking through the built documentation, I also noticed that the first tutorial had lots of lists and equations that weren't rendered correctly. This should also be fixed now.
Related Issues and Pull Requests
Interested Parties