Skip to content
GitLab
Explore
Projects
Groups
Topics
Snippets
Projects
Groups
Topics
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
fusiondirectory
dev-manual
Commits
ffa8fab1
Verified
Commit
ffa8fab1
authored
1 month ago
by
dockx thibault
Browse files
Options
Download
Patches
Plain Diff
Write User Documentation - dev manual
Dev Manual - add dev doc for sphinx
parent
c6328102
dev
92-migration-explain-how-obsolete-work-in-the-dev-manual-and-update-our-logic
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
source/fusiondirectory/sphinx/index.rst
+2
-2
source/fusiondirectory/sphinx/index.rst
source/fusiondirectory/sphinx/sphinx.rst
+2
-14
source/fusiondirectory/sphinx/sphinx.rst
with
4 additions
and
16 deletions
+4
-16
source/fusiondirectory/sphinx/index.rst
+
2
−
2
View file @
ffa8fab1
Writ
ing d
ocumentation
for your new plugin
Writ
e User D
ocumentation
========================
=================
========================
How to properly write a documentation in Sphinx for your new plugin.
How to properly write a documentation in Sphinx for your new plugin.
...
...
This diff is collapsed.
Click to expand it.
source/fusiondirectory/sphinx/sphinx.rst
+
2
−
14
View file @
ffa8fab1
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment
Menu
Explore
Projects
Groups
Topics
Snippets