docs: Fix broken mkdocs links #587
Merged
Conversation
This file contains 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
…-gallery is preventing this)
WalkthroughThis pull request primarily focuses on updating documentation and comments across the Changes
TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Files selected for processing (18)
- docs/api/migration.md (2 hunks)
- docs/dataclasses.md (2 hunks)
- docs/decorators.md (5 hunks)
- docs/widgets.md (9 hunks)
- src/magicgui/tqdm.py (1 hunks)
- src/magicgui/type_map/_magicgui.py (2 hunks)
- src/magicgui/type_map/_type_map.py (1 hunks)
- src/magicgui/types.py (2 hunks)
- src/magicgui/widgets/_concrete.py (1 hunks)
- src/magicgui/widgets/_function_gui.py (2 hunks)
- src/magicgui/widgets/_table.py (1 hunks)
- src/magicgui/widgets/bases/_button_widget.py (1 hunks)
- src/magicgui/widgets/bases/_categorical_widget.py (1 hunks)
- src/magicgui/widgets/bases/_container_widget.py (2 hunks)
- src/magicgui/widgets/bases/_ranged_widget.py (2 hunks)
- src/magicgui/widgets/bases/_slider_widget.py (1 hunks)
- src/magicgui/widgets/bases/_value_widget.py (1 hunks)
- src/magicgui/widgets/protocols.py (1 hunks)
Files skipped from review due to trivial changes (18)
- docs/api/migration.md
- docs/dataclasses.md
- docs/decorators.md
- docs/widgets.md
- src/magicgui/tqdm.py
- src/magicgui/type_map/_magicgui.py
- src/magicgui/type_map/_type_map.py
- src/magicgui/types.py
- src/magicgui/widgets/_concrete.py
- src/magicgui/widgets/_function_gui.py
- src/magicgui/widgets/_table.py
- src/magicgui/widgets/bases/_button_widget.py
- src/magicgui/widgets/bases/_categorical_widget.py
- src/magicgui/widgets/bases/_container_widget.py
- src/magicgui/widgets/bases/_ranged_widget.py
- src/magicgui/widgets/bases/_slider_widget.py
- src/magicgui/widgets/bases/_value_widget.py
- src/magicgui/widgets/protocols.py
|
The CodeRabbitAI bot summaries are highly misleading. I didn't add a new method, add extra typing, or remove references to anything. It's a straightforward PR that only updates the hyperlinks. |
|
summary: mkdocs autorefs is currently incompatible with |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #584
Previously with just plain mkdocs involved, links to functions/classes/etc. would automatically resolve, even when nothing was written between the second set of square brackets. So, this used to work, and you could click it in the built HTML docs and be taken to the corresponding magicgui.widgets.Container page:
But when we combined mkdocs and mkdocs-gallery (to make our examples gallery) it stopped automatically resolving those links for us in the docs. I'm not sure why that happens, but the quickest solution is to explicitly specify the link each time. This PR does just that.
summary