🔧 MAINTAIN: Add isort

Author: chrisjsewell

.pre-commit-config.yaml

@@ -23,6 +23,11 @@ repos:
     hooks:
     - id: check-manifest
 
+  - repo: https://github.com/pycqa/isort
+    rev: 5.8.0
+    hooks:
+    - id: isort
+
   - repo: https://github.com/psf/black
     rev: 20.8b1
     hooks:

pyproject.toml

@@ -1,3 +1,7 @@
 [build-system]
 requires = ["setuptools>=46.4.0", "wheel"]
 build-backend = "setuptools.build_meta"
+
+[tool.isort]
+profile = "black"
+src_paths = ["sphinx_external_toc", "tests"]

setup.cfg

@@ -45,7 +45,7 @@ jb.cmdline =
 
 [options.extras_require]
 code_style =
-    pre-commit==2.6
+    pre-commit~=2.12
 rtd =
     myst-parser~=0.13.5
     sphinx_book_theme>=0.0.36

sphinx_external_toc/__init__.py

@@ -12,10 +12,10 @@
 def setup(app: "Sphinx") -> dict:
     """Initialize the Sphinx extension."""
     from .events import (
-        add_changed_toctrees,
         InsertToctrees,
-        parse_toc_to_env,
         TableofContents,
+        add_changed_toctrees,
+        parse_toc_to_env,
     )
 
     # variables

sphinx_external_toc/api.py

@@ -4,8 +4,8 @@
 from typing import Any, Dict, Iterator, List, Optional, Sequence, Set, Tuple, Union
 
 import attr
-from attr.validators import instance_of, deep_iterable, optional
 import yaml
+from attr.validators import deep_iterable, instance_of, optional
 
 FILE_KEY = "file"
 GLOB_KEY = "glob"

sphinx_external_toc/cli.py

@@ -4,7 +4,7 @@
 import yaml
 
 from sphinx_external_toc import __version__
-from sphinx_external_toc.api import parse_toc_yaml, create_toc_dict
+from sphinx_external_toc.api import create_toc_dict, parse_toc_yaml
 from sphinx_external_toc.tools import create_site_from_toc, create_site_map_from_path
 
 

sphinx_external_toc/events.py

@@ -14,7 +14,7 @@
 from sphinx.util.docutils import SphinxDirective
 from sphinx.util.matching import Matcher, patfilter, patmatch
 
-from .api import DocItem, GlobItem, FileItem, SiteMap, UrlItem, parse_toc_yaml
+from .api import DocItem, FileItem, GlobItem, SiteMap, UrlItem, parse_toc_yaml
 
 logger = logging.getLogger(__name__)
 

sphinx_external_toc/tools.py

@@ -1,11 +1,11 @@
+import re
+import shutil
 from fnmatch import fnmatch
 from itertools import chain
 from pathlib import Path, PurePosixPath
-import re
-import shutil
 from typing import Mapping, Optional, Sequence, Tuple, Union
 
-from .api import parse_toc_yaml, SiteMap, DocItem, TocItem, FileItem
+from .api import DocItem, FileItem, SiteMap, TocItem, parse_toc_yaml
 
 
 def create_site_from_toc(

tests/test_cli.py

@@ -2,12 +2,11 @@
 from pathlib import Path
 from typing import List
 
+import pytest
 from click.testing import CliRunner
 
-from sphinx_external_toc.cli import main, parse_toc, create_toc
 from sphinx_external_toc import __version__
-
-import pytest
+from sphinx_external_toc.cli import create_toc, main, parse_toc
 
 
 @pytest.fixture()

tests/test_sphinx.py

@@ -2,8 +2,8 @@
 from pathlib import Path
 
 import pytest
-from sphinx.testing.util import SphinxTestApp
 from sphinx.testing.path import path as sphinx_path
+from sphinx.testing.util import SphinxTestApp
 
 from sphinx_external_toc.tools import create_site_from_toc