Fork codeinclude plugin to enable fail-on-not-found functionality
#832
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
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.
The
codeincludeplugin we use has undesirable behavior: when it can't find the injection target, it instead injects the entire file as opposed to throwing an errorAdditionally, it uses the
better-setuptools-git-versionmodule, which breaks completely on Python 3.10 -- our fork strips this out as well.I have forked the plugin to https://github.com/trinsic-id/mkdocs-codeinclude-plugin, and resolved the two above issues in said fork.
This PR changes
docs/requirements.txtto use the forked version.Note: This PR will intentionally enter our docs into a broken state, wherein they fail to build. This is because we have one or more failed code injection sites. This is desirable; I will create a PR to fix these issues as soon as this one is merged.