-
-
Notifications
You must be signed in to change notification settings - Fork 306
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: automate creation of double project.toml/hatch.toml tabs #966
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
Also add a simplified style for single code tabs
Please view the diff with whitespace ignored |
I have further checked that this edit doesn't cause unexpected diffs to the site. Done as follows: git checkout master && hatch run docs:mkdocs build -d sitebefore -f - <<<"{INHERIT: mkdocs.yml, plugins: {git-revision-date-localized: {enabled: false}}}" &&
git checkout tabhook && hatch run docs:mkdocs build -d siteafter -f - <<<"{INHERIT: mkdocs.yml, plugins: {git-revision-date-localized: {enabled: false}}}" &&
colordiff -U3 -r sitebefore siteafter | less |
dude that's awesome after I fix CI I was planning on checking that so you saved me a lot of time |
ofek
approved these changes
Oct 8, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you very much!
github-actions bot
pushed a commit
that referenced
this pull request
Oct 8, 2023
* Docs: automate creation of double project.toml/hatch.toml tabs Also add a simplified style for single code tabs * Fix lint * Fix lint 2 * fix formatting * Further fixes --------- Co-authored-by: Ofek Lev <[email protected]> dc961c4
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.
This introduces two new special shorthand syntaxes that can be used anywhere in the docs of Hatch:
All the source Markdown files are converted to use the shorthands everywhere.
The implementation for the new syntaxes is in
scripts/mkdocs_hooks.py
Let me know what you think :) In any case it was fun to make