Test documentation navbar sorting script #956
Open
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 script can be used to sort specific sections of a text file, like the navbars in documentation.
The script usage:
<script> [file-to-sort] [start-mark] [end-mark]
file-to-sort is
mkdocs.yml
by default. The start & end marks are#pre-commit-sort-start
and#pre-commit-sort-end
by default, which can be seen inmkdocs.yml
file.If we would like to use it then it should definitely be added as a pre-commit hook, not as a loose script. I had problems with creating a working pre-commit hook , so I'll push this script as is for now.
Merge after #955, if at all
*EDIT
Turns out the script can be easily run if it's present in the repo locally. I've changed the .pre-commit-config to run it only on the "mkdocs.yml" file and it works fine. It would be better to move it to a different repository, but I haven't figured out how to do that.