From ffa8fab1aef7e9077d498988fce6837778e0c2ce Mon Sep 17 00:00:00 2001
From: Thibault Dockx <thibault.dockx@fusiondirectory.org>
Date: Mon, 17 Feb 2025 09:45:41 +0000
Subject: [PATCH] :sparkles: Write User Documentation - dev manual
Dev Manual - add dev doc for sphinx
---
source/fusiondirectory/sphinx/index.rst | 4 ++--
source/fusiondirectory/sphinx/sphinx.rst | 16 ++--------------
2 files changed, 4 insertions(+), 16 deletions(-)
diff --git a/source/fusiondirectory/sphinx/index.rst b/source/fusiondirectory/sphinx/index.rst
index 64841dc..294f9aa 100644
--- a/source/fusiondirectory/sphinx/index.rst
+++ b/source/fusiondirectory/sphinx/index.rst
@@ -1,5 +1,5 @@
-Writing documentation for your new plugin
-=========================================
+Write User Documentation
+========================
How to properly write a documentation in Sphinx for your new plugin.
diff --git a/source/fusiondirectory/sphinx/sphinx.rst b/source/fusiondirectory/sphinx/sphinx.rst
index 6826e69..8829aa4 100644
--- a/source/fusiondirectory/sphinx/sphinx.rst
+++ b/source/fusiondirectory/sphinx/sphinx.rst
@@ -101,19 +101,7 @@ Each attribute should be clearly described with its purpose, type, and possible
- **Type**: String
- **Example**: ``user@example.com``
-4. Adding Code Examples
-Use code blocks to demonstrate examples. Ensure the language is specified for syntax highlighting.
-
-**Example (PHP):**
-
-.. code-block:: php
-
- private static function example(string $myString): void {
- // This is an example function
- return "Hello, Sphinx!";
- }
-
-5. Including Images and Diagrams
+4. Including Images and Diagrams
Place images inside the `images/` folder and reference them in your documentation as follows:
.. code-block:: rst
@@ -121,7 +109,7 @@ Place images inside the `images/` folder and reference them in your documentatio
.. image:: images/example.png
:alt: Example Image
-6. Cross-Referencing Sections and Files
+5. Cross-Referencing Sections and Files
To create cross-references, use:
.. code-block:: rst
--
GitLab