Add new plugin hooks documentation

.readthedocs.yaml

@@ -0,0 +1,27 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: source/conf.py
+
+formats:
+  - htmlzip
+  - pdf
+  - epub
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: requirements.txt

Makefile

@@ -22,7 +22,6 @@ I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
 #Watcher
 ALLSPHINXLIVEOPTS   = $(ALLSPHINXOPTS) -q \
-   -B \
    --delay 1 \
    --ignore "*.swp" \
    --ignore "*.pdf" \
@@ -73,7 +72,7 @@ html:
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
 livehtml:
-	$(SPHINXAUTOBUILD) -b html $(ALLSPHINXLIVEOPTS) $(BUILDDIR)/html
+	$(SPHINXAUTOBUILD) -b html $(ALLSPHINXLIVEOPTS) $(BUILDDIR)/html --host 0.0.0.0 --port 8007
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 

source/codingstandards.rst

@@ -245,33 +245,9 @@ Examples:
 Checking standards
 ------------------
 
-In order to check standards are respected, we provide a defaut configuration for `PHP CodeSniffer <http://pear.php.net/package/PHP_CodeSniffer>`_ rules. From the GLPI directory, just run:
+Linting (checking and fixing coding standards) is a good way to ensure code quality and consistency of the code base.
+This is done using [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer), [PHPStan](https://phpstan.org/), [ESLint](https://eslint.org/), [Stylelint](https://stylelint.io/) and [TwigCS](https://github.com/friendsoftwig/twigcs).
 
-.. code-block::
-
-   phpcs .
-
-If the above command does not provide any output, then, all is OK :)
-
-An example error output would looks like:
-
-.. code-block:: bash
-
-   phpcs .
-
-   FILE: /var/www/webapps/glpi/tests/HtmlTest.php
-   ----------------------------------------------------------------------
-   FOUND 3 ERRORS AFFECTING 3 LINES
-   ----------------------------------------------------------------------
-    40 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found
-       |       |     3
-    59 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found
-       |       |     3
-    64 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found
-       |       |     3
-
-To automatically fix most of the issues, use `phpcbf`, it will per default rely on default configuration:
-
-.. code-block::
-
-   phpcbf .
+This can run the tasks using Docker, on your local host use `./tests/run_tests.sh lint` to proceed to all linting tasks, or use a scoped task, `./tests/run_tests.sh lint_php` to proceed to PHP linting only for example.
+All possible lintings are listed in the `./tests/run_tests.sh` script.
+For faster action you can run the scripts on your local machine or Docker development container using `node_modules/.bin/eslint . && echo "ESLint found no errors"` for example. You can find all the commands in [`.github/actions` directory](https://github.com/glpi-project/glpi/tree/main/.github/actions).

source/conf.py

@@ -86,7 +86,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'En'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -166,7 +166,7 @@
 # html_logo = None
 
 #Will be marked as missing during the build, but is provided from theme.
-html_logo = 'static/images/glpi.png'
+html_logo = '_static/images/glpi.png'
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32