Skip to content

Commit 37dcd46

Browse files
Merge pull request #1757 from anirudnits/issue/1755
Issue/1755
2 parents 3de1890 + 321b1db commit 37dcd46

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

docs/configuration/black_compatibility.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Compatibility with black is very important to the isort project and comes baked
77
All that's required to use isort alongside black is to set the isort profile to "black".
88

99
!!! tip
10-
Beyond the profile, it is common to set [skip_gitignore](https://pycqa.github.io/isort/docs/configuration/options/#skip-gitignore) (which is not enabled by default for isort as it requires git to be installed) and [line_length](https://pycqa.github.io/isort/docs/configuration/options/#skip-gitignore) as it is common to deviate from black's default of 88.
10+
Beyond the profile, it is common to set [skip_gitignore](https://pycqa.github.io/isort/docs/configuration/options.html#skip-gitignore) (which is not enabled by default for isort as it requires git to be installed) and [line_length](https://pycqa.github.io/isort/docs/configuration/options.html#line-length) as it is common to deviate from black's default of 88.
1111

1212

1313
## Using a config file (such as .isort.cfg)
@@ -23,7 +23,7 @@ profile = "black"
2323
multi_line_output = 3
2424
```
2525

26-
Read More about supported [config files](https://pycqa.github.io/isort/docs/configuration/config_files/).
26+
Read More about supported [config files](https://pycqa.github.io/isort/docs/configuration/config_files.html).
2727

2828
## CLI
2929

@@ -51,7 +51,7 @@ after_success:
5151

5252
```
5353

54-
See [built-in profiles](https://pycqa.github.io/isort/docs/configuration/profiles/) for more profiles.
54+
See [built-in profiles](https://pycqa.github.io/isort/docs/configuration/profiles.html) for more profiles.
5555

5656
## Integration with pre-commit
5757

docs/configuration/config_files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ src_paths=isort,test
8181

8282
## Custom config files
8383

84-
Optionally, you can also create a config file with a custom name, or directly point isort to a config file that falls lower in the priority order, by using [--settings-file](https://pycqa.github.io/isort/docs/configuration/options/#settings-path).
84+
Optionally, you can also create a config file with a custom name, or directly point isort to a config file that falls lower in the priority order, by using [--settings-file](https://pycqa.github.io/isort/docs/configuration/options.html#settings-path).
8585
This can be useful, for instance, if you want to have one configuration for `.py` files and another for `.pyx` - while keeping the config files at the root of your repository.
8686

8787
!!! tip

docs/configuration/custom_sections_and_ordering.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,15 +115,15 @@ import b
115115
from a import a # This will always appear below because it is a from import.
116116
```
117117

118-
However, if you prefer to keep strict alphabetical sorting you can set [force sort within sections](https://pycqa.github.io/isort/docs/configuration/options/#force-sort-within-sections) to true. Resulting in:
118+
However, if you prefer to keep strict alphabetical sorting you can set [force sort within sections](https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections) to true. Resulting in:
119119

120120

121121
```python
122122
from a import a # This will now appear at top because a appears in the alphabet before b
123123
import b
124124
```
125125

126-
You can even tell isort to always place from imports on top, instead of the default of placing them on bottom, using [from first](https://pycqa.github.io/isort/docs/configuration/options/#from-first).
126+
You can even tell isort to always place from imports on top, instead of the default of placing them on bottom, using [from first](https://pycqa.github.io/isort/docs/configuration/options.html#from-first).
127127

128128
```python
129129
from b import b # If from first is set to True, all from imports will be placed before non-from imports.

docs/configuration/multi_line_output_modes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Multi Line Output Modes
22

3-
This [config option](https://pycqa.github.io/isort/docs/configuration/options/#multi-line-output) defines how from imports wrap when they extend past the line\_length
3+
This [config option](https://pycqa.github.io/isort/docs/configuration/options.html#multi-line-output) defines how from imports wrap when they extend past the line\_length
44
limit and has 12 possible settings:
55

66
## 0 - Grid

docs/configuration/options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ isort will disagree but commit to your way of formatting. To enable this, isort
55
how you want your imports sorted, organized, and formatted.
66

77
Too busy to build your perfect isort configuration? For curated common configurations, see isort's [built-in
8-
profiles](https://pycqa.github.io/isort/docs/configuration/profiles/).
8+
profiles](https://pycqa.github.io/isort/docs/configuration/profiles.html).
99

1010
## Python Version
1111

docs/upgrade_guides/5.0.0.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide is meant to help migrate projects from using isort 4.x.x unto the 5.0
66
Related documentation:
77

88
* [isort 5.0.0 changelog](https://pycqa.github.io/isort/CHANGELOG/#500-penny-july-4-2020)
9-
* [isort 5 release document](https://pycqa.github.io/isort/docs/major_releases/introducing_isort_5/)
9+
* [isort 5 release document](https://pycqa.github.io/isort/docs/major_releases/introducing_isort_5.html)
1010

1111
!!! important - "If you use pre-commit remove seed-isort-config."
1212
If you currently use pre-commit, make sure to see the pre-commit section of this document. In particular, make sure to remove any `seed-isort-config` pre-step.
@@ -19,7 +19,7 @@ for those of us who have gotten used to placing imports right above their usage
1919

2020
If you want to move all imports to the top, you can use the new`--float-to-top` flag in the CLI or `float_to_top=true` option in your config file.
2121

22-
See: [https://pycqa.github.io/isort/docs/configuration/options/#float-to-top](https://pycqa.github.io/isort/docs/configuration/options/#float-to-top)
22+
See: [https://pycqa.github.io/isort/docs/configuration/options.html#float-to-top](https://pycqa.github.io/isort/docs/configuration/options.html#float-to-top)
2323

2424
## Migrating CLI options
2525

@@ -46,7 +46,7 @@ The `-v` (previously for version now for verbose) and `-V` (previously for verbo
4646

4747
The first thing to keep in mind is how isort loads config options has changed in isort 5. It will no longer merge multiple config files, instead you must have 1 isort config per a project.
4848
If you have multiple configs, they will need to be merged into 1 single one. You can see the priority order of configuration files and the manner in which they are loaded on the
49-
[config files documentation page](https://pycqa.github.io/isort/docs/configuration/config_files/).
49+
[config files documentation page](https://pycqa.github.io/isort/docs/configuration/config_files.html).
5050

5151
!!! tip - "Config options are loaded relative to the file, not the isort instance."
5252
isort looks for a config file based on the path of the file you request to sort. If you have your config placed outside of the project, you can use `--settings-path` to manually specify the config location instead. Full information about how config files are loaded is in the linked config files documentation page.
@@ -62,7 +62,7 @@ The option was originally added to allow working around this, and was then turne
6262
### `known_standard_library`
6363
isort settings no longer merge together, instead they override. The old behavior of merging together caused many hard to
6464
track down errors, but the one place it was very convenient was for adding a few additional standard library modules.
65-
In isort 5, you can still get this behavior by moving your extra modules from the `known_standard_library` setting to [`extra_standard_library`](https://pycqa.github.io/isort/docs/configuration/options/#extra-standard-library).
65+
In isort 5, you can still get this behavior by moving your extra modules from the `known_standard_library` setting to [`extra_standard_library`](https://pycqa.github.io/isort/docs/configuration/options.html#extra-standard-library).
6666

6767
### module placement changes: `known_third_party`, `known_first_party`, `default_section`, etc...
6868
isort has completely rewritten its logic for placing modules in 5.0.0 to ensure the same behavior across environments. You can see the details of this change [here](https://github.com/pycqa/isort/issues/1147).

0 commit comments

Comments
 (0)