diff --git a/source/fusiondirectory/sphinx/index.rst b/source/fusiondirectory/sphinx/index.rst index 64841dc77ab8efe685c2c0ce8e2084856ed7471a..294f9aa09d97f0db1d6ba4fe6a915c969922c7e3 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 6826e69035a62cca88646c445b39ecb571a68501..8829aa467fd2a51ef48b00a88856115a34461b80 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