Verified Commit ffa8fab1 authored by dockx thibault's avatar dockx thibault
Browse files

:sparkles: Write User Documentation - dev manual

Dev Manual - add dev doc for sphinx
Showing with 4 additions and 16 deletions
+4 -16
Writing documentation for your new plugin Write User Documentation
========================================= ========================
How to properly write a documentation in Sphinx for your new plugin. How to properly write a documentation in Sphinx for your new plugin.
......
...@@ -101,19 +101,7 @@ Each attribute should be clearly described with its purpose, type, and possible ...@@ -101,19 +101,7 @@ Each attribute should be clearly described with its purpose, type, and possible
- **Type**: String - **Type**: String
- **Example**: ``user@example.com`` - **Example**: ``user@example.com``
4. Adding Code Examples 4. Including Images and Diagrams
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
Place images inside the `images/` folder and reference them in your documentation as follows: Place images inside the `images/` folder and reference them in your documentation as follows:
.. code-block:: rst .. code-block:: rst
...@@ -121,7 +109,7 @@ Place images inside the `images/` folder and reference them in your documentatio ...@@ -121,7 +109,7 @@ Place images inside the `images/` folder and reference them in your documentatio
.. image:: images/example.png .. image:: images/example.png
:alt: Example Image :alt: Example Image
6. Cross-Referencing Sections and Files 5. Cross-Referencing Sections and Files
To create cross-references, use: To create cross-references, use:
.. code-block:: rst .. code-block:: rst
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment