diff options
| author | Timothy Edmund Crosley <timothy.crosley@gmail.com> | 2022-05-11 13:42:47 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-11 13:42:47 -0700 |
| commit | 798ea224eeee2e740882920822c74a0aa9e25458 (patch) | |
| tree | c18e9416d286286afbe4b4717a0ea9b15179923d /docs | |
| parent | 58685a4735208770838b46142bc45b9ab83af837 (diff) | |
| parent | 485f8adcddc174117925b59bf9d913fd33d37984 (diff) | |
| download | isort-798ea224eeee2e740882920822c74a0aa9e25458.tar.gz | |
Merge branch 'main' into trailing_comma
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/github_action.md | 2 | ||||
| -rw-r--r-- | docs/configuration/options.md | 5 | ||||
| -rw-r--r-- | docs/howto/shared_profiles.md | 18 |
3 files changed, 23 insertions, 2 deletions
diff --git a/docs/configuration/github_action.md b/docs/configuration/github_action.md index c7a8dc97..343a2725 100644 --- a/docs/configuration/github_action.md +++ b/docs/configuration/github_action.md @@ -52,7 +52,7 @@ jobs: - uses: actions/setup-python@v2 with: python-version: 3.8 - - uses: jamescurtin/isort-action@master + - uses: isort/isort-action@master with: requirementsFiles: "requirements.txt requirements-test.txt" ``` diff --git a/docs/configuration/options.md b/docs/configuration/options.md index 56239d6f..38de3040 100644 --- a/docs/configuration/options.md +++ b/docs/configuration/options.md @@ -1143,7 +1143,10 @@ Inserts a blank line before a comment following an import. ## Profile -Base profile type to use for configuration. Profiles include: black, django, pycharm, google, open_stack, plone, attrs, hug, wemake, appnexus. As well as any shared profiles. +Base profile type to use for configuration. Profiles include: black, django, +pycharm, google, open\_stack, plone, attrs, hug, wemake, appnexus. As well as +any [shared +profiles](https://pycqa.github.io/isort/docs/howto/shared_profiles.html). **Type:** String **Default:** ` ` diff --git a/docs/howto/shared_profiles.md b/docs/howto/shared_profiles.md new file mode 100644 index 00000000..3ed8b52e --- /dev/null +++ b/docs/howto/shared_profiles.md @@ -0,0 +1,18 @@ +# Shared Profiles + +As well as the [built in +profiles](https://pycqa.github.io/isort/docs/configuration/profiles.html), you +can define and share your own profiles. + +All that's required is to create a Python package that exposes an entry point to +a dictionary exposing profile settings under `isort.profiles`. An example is +available [within the `isort` +repo](https://github.com/PyCQA/isort/tree/main/example_shared_isort_profile) + +### Example `.isort.cfg` + +``` +[options.entry_points] +isort.profiles = + shared_profile=my_module:PROFILE +``` |