Restructure reference docs to match gh-pages: one page per module Agent-Logs-Url: https://github.com/PyCQA/isort/sessions/b43413f5-bfa2-4d59-a1f5-ffd6f80b0c2b Co-authored-by: DanielNoord <13665637+DanielNoord@users.noreply.github.com>
diff --git a/docs/index.rst b/docs/index.rst index 796fb74..57d8e71 100644 --- a/docs/index.rst +++ b/docs/index.rst
@@ -75,7 +75,7 @@ :caption: Reference :hidden: - reference/isort + reference/isort/index .. toctree:: :maxdepth: 2
diff --git a/docs/reference/isort.rst b/docs/reference/isort.rst deleted file mode 100644 index 42d8598..0000000 --- a/docs/reference/isort.rst +++ /dev/null
@@ -1,50 +0,0 @@ -API Reference -============= - -isort ------ - -.. automodule:: isort - :members: - :undoc-members: - :show-inheritance: - -isort.api ---------- - -.. automodule:: isort.api - :members: - :undoc-members: - :show-inheritance: - -isort.main ----------- - -.. automodule:: isort.main - :members: - :undoc-members: - :show-inheritance: - -isort.place ------------ - -.. automodule:: isort.place - :members: - :undoc-members: - :show-inheritance: - -isort.sections --------------- - -.. automodule:: isort.sections - :members: - :undoc-members: - :show-inheritance: - -isort.exceptions ----------------- - -.. automodule:: isort.exceptions - :members: - :undoc-members: - :show-inheritance:
diff --git a/docs/reference/isort/api.rst b/docs/reference/isort/api.rst new file mode 100644 index 0000000..34f71e2 --- /dev/null +++ b/docs/reference/isort/api.rst
@@ -0,0 +1,7 @@ +isort.api +========= + +.. automodule:: isort.api + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/comments.rst b/docs/reference/isort/comments.rst new file mode 100644 index 0000000..36f020b --- /dev/null +++ b/docs/reference/isort/comments.rst
@@ -0,0 +1,7 @@ +isort.comments +============== + +.. automodule:: isort.comments + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/core.rst b/docs/reference/isort/core.rst new file mode 100644 index 0000000..d0e36dd --- /dev/null +++ b/docs/reference/isort/core.rst
@@ -0,0 +1,7 @@ +isort.core +========== + +.. automodule:: isort.core + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/exceptions.rst b/docs/reference/isort/exceptions.rst new file mode 100644 index 0000000..a6ab452 --- /dev/null +++ b/docs/reference/isort/exceptions.rst
@@ -0,0 +1,7 @@ +isort.exceptions +================ + +.. automodule:: isort.exceptions + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/files.rst b/docs/reference/isort/files.rst new file mode 100644 index 0000000..7a3494b --- /dev/null +++ b/docs/reference/isort/files.rst
@@ -0,0 +1,7 @@ +isort.files +=========== + +.. automodule:: isort.files + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/format.rst b/docs/reference/isort/format.rst new file mode 100644 index 0000000..466e251 --- /dev/null +++ b/docs/reference/isort/format.rst
@@ -0,0 +1,7 @@ +isort.format +============ + +.. automodule:: isort.format + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/hooks.rst b/docs/reference/isort/hooks.rst new file mode 100644 index 0000000..7976f3a --- /dev/null +++ b/docs/reference/isort/hooks.rst
@@ -0,0 +1,7 @@ +isort.hooks +=========== + +.. automodule:: isort.hooks + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/identify.rst b/docs/reference/isort/identify.rst new file mode 100644 index 0000000..7513e25 --- /dev/null +++ b/docs/reference/isort/identify.rst
@@ -0,0 +1,7 @@ +isort.identify +============== + +.. automodule:: isort.identify + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/index.rst b/docs/reference/isort/index.rst new file mode 100644 index 0000000..c5df01e --- /dev/null +++ b/docs/reference/isort/index.rst
@@ -0,0 +1,35 @@ +isort +===== + +.. automodule:: isort + :members: + :undoc-members: + :show-inheritance: + +.. toctree:: + :maxdepth: 1 + :caption: Submodules + + api + comments + core + exceptions + files + format + hooks + identify + io + literal + logo + main + output + parse + place + profiles + sections + settings + sorting + stdlibs/index + utils + wrap + wrap_modes
diff --git a/docs/reference/isort/io.rst b/docs/reference/isort/io.rst new file mode 100644 index 0000000..49deb37 --- /dev/null +++ b/docs/reference/isort/io.rst
@@ -0,0 +1,7 @@ +isort.io +======== + +.. automodule:: isort.io + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/literal.rst b/docs/reference/isort/literal.rst new file mode 100644 index 0000000..7399a86 --- /dev/null +++ b/docs/reference/isort/literal.rst
@@ -0,0 +1,7 @@ +isort.literal +============= + +.. automodule:: isort.literal + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/logo.rst b/docs/reference/isort/logo.rst new file mode 100644 index 0000000..cd5d0f5 --- /dev/null +++ b/docs/reference/isort/logo.rst
@@ -0,0 +1,7 @@ +isort.logo +========== + +.. automodule:: isort.logo + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/main.rst b/docs/reference/isort/main.rst new file mode 100644 index 0000000..9017449 --- /dev/null +++ b/docs/reference/isort/main.rst
@@ -0,0 +1,7 @@ +isort.main +========== + +.. automodule:: isort.main + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/output.rst b/docs/reference/isort/output.rst new file mode 100644 index 0000000..0ae9fd9 --- /dev/null +++ b/docs/reference/isort/output.rst
@@ -0,0 +1,7 @@ +isort.output +============ + +.. automodule:: isort.output + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/parse.rst b/docs/reference/isort/parse.rst new file mode 100644 index 0000000..8cc5992 --- /dev/null +++ b/docs/reference/isort/parse.rst
@@ -0,0 +1,7 @@ +isort.parse +=========== + +.. automodule:: isort.parse + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/place.rst b/docs/reference/isort/place.rst new file mode 100644 index 0000000..78146a2 --- /dev/null +++ b/docs/reference/isort/place.rst
@@ -0,0 +1,7 @@ +isort.place +=========== + +.. automodule:: isort.place + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/profiles.rst b/docs/reference/isort/profiles.rst new file mode 100644 index 0000000..6143b93 --- /dev/null +++ b/docs/reference/isort/profiles.rst
@@ -0,0 +1,7 @@ +isort.profiles +============== + +.. automodule:: isort.profiles + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/sections.rst b/docs/reference/isort/sections.rst new file mode 100644 index 0000000..e9f4f0e --- /dev/null +++ b/docs/reference/isort/sections.rst
@@ -0,0 +1,7 @@ +isort.sections +============== + +.. automodule:: isort.sections + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/settings.rst b/docs/reference/isort/settings.rst new file mode 100644 index 0000000..68971d4 --- /dev/null +++ b/docs/reference/isort/settings.rst
@@ -0,0 +1,7 @@ +isort.settings +============== + +.. automodule:: isort.settings + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/sorting.rst b/docs/reference/isort/sorting.rst new file mode 100644 index 0000000..ee6e5c0 --- /dev/null +++ b/docs/reference/isort/sorting.rst
@@ -0,0 +1,7 @@ +isort.sorting +============= + +.. automodule:: isort.sorting + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/all.rst b/docs/reference/isort/stdlibs/all.rst new file mode 100644 index 0000000..279a61a --- /dev/null +++ b/docs/reference/isort/stdlibs/all.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.all +================= + +.. automodule:: isort.stdlibs.all + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/index.rst b/docs/reference/isort/stdlibs/index.rst new file mode 100644 index 0000000..2a998ae --- /dev/null +++ b/docs/reference/isort/stdlibs/index.rst
@@ -0,0 +1,26 @@ +isort.stdlibs +============= + +.. automodule:: isort.stdlibs + :members: + :undoc-members: + :show-inheritance: + +.. toctree:: + :maxdepth: 1 + :caption: Versions + + all + py2 + py27 + py3 + py36 + py37 + py38 + py39 + py310 + py311 + py312 + py313 + py314 + py315
diff --git a/docs/reference/isort/stdlibs/py2.rst b/docs/reference/isort/stdlibs/py2.rst new file mode 100644 index 0000000..ebdfe6d --- /dev/null +++ b/docs/reference/isort/stdlibs/py2.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py2 +================= + +.. automodule:: isort.stdlibs.py2 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py27.rst b/docs/reference/isort/stdlibs/py27.rst new file mode 100644 index 0000000..8cf1611 --- /dev/null +++ b/docs/reference/isort/stdlibs/py27.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py27 +================== + +.. automodule:: isort.stdlibs.py27 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py3.rst b/docs/reference/isort/stdlibs/py3.rst new file mode 100644 index 0000000..e7a79a4 --- /dev/null +++ b/docs/reference/isort/stdlibs/py3.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py3 +================= + +.. automodule:: isort.stdlibs.py3 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py310.rst b/docs/reference/isort/stdlibs/py310.rst new file mode 100644 index 0000000..edf854d --- /dev/null +++ b/docs/reference/isort/stdlibs/py310.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py310 +=================== + +.. automodule:: isort.stdlibs.py310 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py311.rst b/docs/reference/isort/stdlibs/py311.rst new file mode 100644 index 0000000..5ab0438 --- /dev/null +++ b/docs/reference/isort/stdlibs/py311.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py311 +=================== + +.. automodule:: isort.stdlibs.py311 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py312.rst b/docs/reference/isort/stdlibs/py312.rst new file mode 100644 index 0000000..3a86dba --- /dev/null +++ b/docs/reference/isort/stdlibs/py312.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py312 +=================== + +.. automodule:: isort.stdlibs.py312 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py313.rst b/docs/reference/isort/stdlibs/py313.rst new file mode 100644 index 0000000..7bfda08 --- /dev/null +++ b/docs/reference/isort/stdlibs/py313.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py313 +=================== + +.. automodule:: isort.stdlibs.py313 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py314.rst b/docs/reference/isort/stdlibs/py314.rst new file mode 100644 index 0000000..293602b --- /dev/null +++ b/docs/reference/isort/stdlibs/py314.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py314 +=================== + +.. automodule:: isort.stdlibs.py314 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py315.rst b/docs/reference/isort/stdlibs/py315.rst new file mode 100644 index 0000000..417b40c --- /dev/null +++ b/docs/reference/isort/stdlibs/py315.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py315 +=================== + +.. automodule:: isort.stdlibs.py315 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py36.rst b/docs/reference/isort/stdlibs/py36.rst new file mode 100644 index 0000000..b30dc31 --- /dev/null +++ b/docs/reference/isort/stdlibs/py36.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py36 +================== + +.. automodule:: isort.stdlibs.py36 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py37.rst b/docs/reference/isort/stdlibs/py37.rst new file mode 100644 index 0000000..1f4438e --- /dev/null +++ b/docs/reference/isort/stdlibs/py37.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py37 +================== + +.. automodule:: isort.stdlibs.py37 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py38.rst b/docs/reference/isort/stdlibs/py38.rst new file mode 100644 index 0000000..290644b --- /dev/null +++ b/docs/reference/isort/stdlibs/py38.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py38 +================== + +.. automodule:: isort.stdlibs.py38 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/stdlibs/py39.rst b/docs/reference/isort/stdlibs/py39.rst new file mode 100644 index 0000000..f830277 --- /dev/null +++ b/docs/reference/isort/stdlibs/py39.rst
@@ -0,0 +1,7 @@ +isort.stdlibs.py39 +================== + +.. automodule:: isort.stdlibs.py39 + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/utils.rst b/docs/reference/isort/utils.rst new file mode 100644 index 0000000..7bc4c6a --- /dev/null +++ b/docs/reference/isort/utils.rst
@@ -0,0 +1,7 @@ +isort.utils +=========== + +.. automodule:: isort.utils + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/wrap.rst b/docs/reference/isort/wrap.rst new file mode 100644 index 0000000..ac35ff6 --- /dev/null +++ b/docs/reference/isort/wrap.rst
@@ -0,0 +1,7 @@ +isort.wrap +========== + +.. automodule:: isort.wrap + :members: + :undoc-members: + :show-inheritance:
diff --git a/docs/reference/isort/wrap_modes.rst b/docs/reference/isort/wrap_modes.rst new file mode 100644 index 0000000..c792b5b --- /dev/null +++ b/docs/reference/isort/wrap_modes.rst
@@ -0,0 +1,7 @@ +isort.wrap_modes +================ + +.. automodule:: isort.wrap_modes + :members: + :undoc-members: + :show-inheritance: