Extends docs with hint when migrating #239
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
2bndy5
reviewed
Apr 11, 2023
Co-authored-by: Brendan <[email protected]>
2bndy5
reviewed
Apr 11, 2023
2bndy5
approved these changes
Apr 11, 2023
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.
as mentioned in #238, here's a little docs extension for people who are switching from another theme. i made it collapsed by default as it could potentially grow. for now i'm setting my migration more or less aside, so that's all as first impression.
on that occasion, i think the docs could really benefit from a section for hackers. i noticed inconsistencies how admonitions are parsed and it took me a while to get a grip how i should set up a test for that. admittedly i'm not in best condition atm and then dealing with
docutilsis just too much of a pita.