Merge branch 'feature/docs' into develop

docs/conf.py

@@ -16,12 +16,14 @@
 
 # pylint: skip-file
 
+from datetime import datetime
+
 from faker_wifi_essid import __version__ as VERSION
 
 # -- Project information -----------------------------------------------------
 
 project = "Faker Wi-Fi ESSID"
-copyright = "2022, Paul-Emmanuel Raoul"
+copyright = f"2018-{datetime.now().year}, Paul-Emmanuel Raoul"
 author = "Paul-Emmanuel Raoul"
 
 # The full version, including alpha/beta/rc tags

docs/development.rst

@@ -0,0 +1,9 @@
+===========
+Development
+===========
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   development/*

docs/documentation.rst → docs/development/documentation.rst

@@ -8,14 +8,14 @@ folder.
 Install the dependencies
 ------------------------
 
-The dependencies required to build the documentation are defined in `setup.py`
-as an optional dependency group called `docs`.
+The dependencies required to build the documentation are defined in
+`pyproject.toml` as an optional dependency group called `docs`.
 
 To install the dependencies in `docs`:
 
 ::
 
-   pip3 install .[docs]
+   pip install .[docs]
 
 
 Build the documentation

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/>`_.
+

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/*

docs/index.rst

@@ -14,10 +14,10 @@ Faker Wi-Fi ESSID is a `Faker`_ provider for Wi-Fi ESSIDs.
 
 .. toctree::
    :caption: Contents
+   :maxdepth: 2
 
    installation
    usage
-   modules
-   documentation
+   development
 
 .. _Faker: https://github.com/joke2k/faker/

docs/installation.rst

@@ -5,9 +5,22 @@ Installation
 From PyPI (recommended)
 -----------------------
 
-::
+To install Faker Wi-Fi ESSID from `PyPI`_ with pip:
 
-    pip3 install --upgrade faker-wifi-essid
+.. code:: sh
+
+    pip install --upgrade faker-wifi-essid
+
+However, as Faker Wi-Fi ESSID is a programming library (a `module <Python
+Modules>`_ in Python parlance), it is most likely to be added as a dependency
+to the `pyproject.toml` file of your project or its equivalent configuration
+file:
+
+.. code:: toml
+
+    dependencies = [
+      "faker_wifi_essid",
+    ]
 
 From sources
 ------------
@@ -17,10 +30,12 @@ Faker Wi-Fi ESSID is packaged with `Setuptools`_.
 The default Git branch is `develop`. To install the latest stable version, you
 need to clone the `main` branch.
 
-::
+.. code:: sh
 
-    git clone -b main git@github.com:SkypLabs/faker-wifi-essid.git
+    git clone -b main https://github.com/SkypLabs/faker-wifi-essid.git
     cd faker-wifi-essid
-    pip3 install .
+    pip install .
 
+.. _Python Modules: https://docs.python.org/3/tutorial/modules.html
+.. _PyPI: https://pypi.org/
 .. _Setuptools: https://pypi.org/project/setuptools/