centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add note about formatting code (#3244)

Browse Source
This commit is contained in:
Timothée Mazzucotelli
2023-06-07 00:43:45 +02:00
committed by GitHub
parent 73c640f73e
commit 45c8b9669b
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/about/contributing.md
View File

@@ -63,6 +63,12 @@ It will attempt to run the tests against all of the Python versions we
support. So don't be concerned if you are missing some. The rest
will be verified by [GitHub Actions] when you submit a pull request.
## Formatting the code
Python code within MkDocs' code base is formatted using [Black] and [Isort].
You can automatically format the code according to these tools
with `hatch run style:format`.
## Translating themes
To localize a theme to your favorite language, follow the guide on [Translating
@@ -111,3 +117,5 @@ file so that everything is ready for translators to do their job.
[PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
[Translating Themes]: ../dev-guide/translations.md
[Jinja's i18n extension]: https://jinja.palletsprojects.com/en/latest/extensions/#i18n-extension
[Black]: https://pypi.org/project/black/
[Isort]: https://pypi.org/project/isort/