Reorganise documentation pages

SkypLabs · Dec 13, 2024 · 82c1c95 · 82c1c95
1 parent 318f01f
commit 82c1c95
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 28 deletions.
diff --git a/docs/development.rst b/docs/development.rst
@@ -2,29 +2,8 @@
 Development
 ===========
 
-Dropping support for deprecated Python versions
------------------------------------------------
+.. toctree::
+   :glob:
+   :maxdepth: 2
 
-When a Python version is officially deprecated, it needs to be removed from the
-versions supported by this package. To do so, the following actions need to be taken:
-
-* In `pyproject.toml`:
-
-  * Remove the Python version from the classifiers.
-  * Update the minimum supported Python version in `requires-python`.
-
-* In `tox.ini`:
-
-  * Remove the Python version from `tox.envlist`.
-
-* In `.github/workflows/test_and_publish.yml`:
-
-  * Remove the Python version from the build matrix.
-
-* In the GitHub repository settings:
-
-  * If necessary, update the required status checks in the branch protection
-    rules.
-
-The status of the Python versions can be found `here
-<https://devguide.python.org/versions/>`_.
+   development/*
diff --git a/docs/documentation.rst → docs/development/documentation.rst b/docs/documentation.rst → docs/development/documentation.rst
diff --git a/docs/development/drop-deprecated-py-versions.rst b/docs/development/drop-deprecated-py-versions.rst
@@ -0,0 +1,28 @@
+===============================================
+Dropping support for deprecated Python versions
+===============================================
+
+When a Python version is officially deprecated, it needs to be removed from the
+versions supported by this package. To do so, the following actions need to be taken:
+
+* In `pyproject.toml`:
+
+  * Remove the Python version from the classifiers.
+  * Update the minimum supported Python version in `requires-python`.
+
+* In `tox.ini`:
+
+  * Remove the Python version from `tox.envlist`.
+
+* In `.github/workflows/test_and_publish.yml`:
+
+  * Remove the Python version from the build matrix.
+
+* In the GitHub repository settings:
+
+  * If necessary, update the required status checks in the branch protection
+    rules.
+
+The status of the Python versions can be found `here
+<https://devguide.python.org/versions/>`_.
+
diff --git a/docs/modules.rst → docs/development/modules.rst b/docs/modules.rst → docs/development/modules.rst
@@ -5,7 +5,7 @@ Modules
 The different modules of Faker Wi-Fi ESSID will be listed here.
 
 .. toctree::
-   :maxdepth: 1
    :glob:
+   :maxdepth: 1
 
    modules/*
diff --git a/docs/modules/faker_wifi_essid.rst → .../development/modules/faker_wifi_essid.rst b/docs/modules/faker_wifi_essid.rst → .../development/modules/faker_wifi_essid.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,11 +14,10 @@ Faker Wi-Fi ESSID is a `Faker`_ provider for Wi-Fi ESSIDs.
 
 .. toctree::
    :caption: Contents
+   :maxdepth: 2
 
    installation
    usage
-   modules
    development
-   documentation
 
 .. _Faker: https://github.com/joke2k/faker/