Skip to content
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
merged 7 commits into from
Oct 8, 2023

Conversation

oprypin
Copy link
Contributor

@oprypin oprypin commented Sep 12, 2023

This introduces two new special shorthand syntaxes that can be used anywhere in the docs of Hatch:

Can write thisTo get this
```python tab="filename.py"     
test test
```
=== ":octicons-file-code-16: filename.py"       
    ```python
    test test
    ```
Can write thisTo get this
```toml config-example          
[tool.hatch.build]
ignore-vcs = true
```
=== ":octicons-file-code-16: pyproject.toml"    
    ```toml
    [tool.hatch.build]
    ignore-vcs = true
    ```

=== ":octicons-file-code-16: hatch.toml"
    ```toml
    [build]
    ignore-vcs = true
    ```

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

Also add a simplified style for single code tabs
@oprypin
Copy link
Contributor Author

oprypin commented Sep 12, 2023

Please view the diff with whitespace ignored

@oprypin oprypin marked this pull request as ready for review September 13, 2023 19:22
@oprypin
Copy link
Contributor Author

oprypin commented Oct 7, 2023

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

@ofek
Copy link
Sponsor Collaborator

ofek commented Oct 7, 2023

dude that's awesome after I fix CI I was planning on checking that so you saved me a lot of time

Copy link
Sponsor Collaborator

@ofek ofek left a 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!

@ofek ofek merged commit dc961c4 into pypa:master Oct 8, 2023
35 checks passed
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
@oprypin oprypin deleted the tabhook branch October 8, 2023 05:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants