ADD-CAP: docuemntation sphinx page for devs

Author: 9and3

doc/documentation.md

@@ -3,11 +3,52 @@
 
 In DF we use `Sphinx` to generate the documentation. The documentation is written in `reStructuredText` and `Markdown` and the source files are located in the `doc` folder. The documentation is hosted on `ReadTheDocs` and is automatically updated when a new commit is pushed to the `main` branch.
 
-Documentation is autogenerated for:
+Follow these guides to contribute to the documentation whether you:
 
-- [GHComponents](gh_components.rst) for the  DF Grasshopper plug-in
-- [Python API](diffCheck_PythonAPI) for the DF Python API
+- add a new [GHComponents](ghcomp_doc_g)
+- add/modify the [Python API](pyapi_doc_g)
+- add a new [tutorial](tutorial_doc_g)
 
+---
+(ghcomp_doc_g)=
+## `GHComponent`'s docs
 
-```{note}
-If you need to add a new page to the documentation (e.g. a [new tutorial](tutorials.rst)), you can do so by adding a new `.rst` file in the `doc` folder and linking it in the `index.rst` file.
+If you write a new [GHComponents](gh_components.rst) you will most probably already have created and filled a `metadata.json` file. DF uses this file to automatically generate the documentation for the GHComponents. The only thing you need to do is:
+* add a new `.rst` file with the name of the component like `gh_DFComponentName.rst`
+* add it to the `gh_components.rst` file's `list-table::`
+  ```{attention}
+    The `list-table::` is organized in two columns so if not pair add simply two empty strings `-` to the end of the last entry.
+* add it to the `toctree::`
+
+Our custom sphinx extension `sphinx_ghcomponent_parser` will automatically parse the `metadata.json` file and generate the documentation for the GHComponent✨✨.
+
+
+(pyapi_doc_g)=
+## `Python API`'s docs
+
+For [Python API documentation](diffCheck_PythonAPI), we use `sphinx-apidoc` to automatically generate the API documentation so the only thing to do is to add beautiful docstrings to the Python code with the following reStructuredText (reST) format style:
+
+```python
+    def example_function(param1, param2):
+    """
+    Summary of the function.
+
+    :param param1: Description of `param1`.
+    :type param1: int
+    :param param2: Description of `param2`.
+    :type param2: str
+    :return: Description of the return value.
+    :rtype: bool
+    """
+    return True
+```
+
+(tutorial_doc_g)=
+## `DF Tutorial`'s docs
+
+If you need to add a new page to the [tutorials](tutorials.rst) (e.g. a [new tutorial](tutorials.rst)), you can do so by adding a new `.rst` file in the `doc` folder and linking it in the `tutorials.rst` file's toctree:
+
+```{eval-rst}
+.. literalinclude:: tutorials.rst
+   :language: rst
+   :lines: 6-14

doc/gh_components.rst

@@ -64,8 +64,10 @@ DF has a Grasshopper_ plugin with a set of components that allows the user to in
      - .. image:: ../src/gh/components/DF_visualization_settings/icon.png
      - `gh_DFVisualizationSettings <gh_DFVisualizationSettings.html>`_
 
-..    * - .. image:: ../src/gh/components/DF_tester/icon.png
-..      - `gh_DFTester <gh_DFTester.html>`_
+   * - .. image:: ../src/gh/components/DF_tester/icon.png
+     - `gh_DFTester <gh_DFTester.html>`_
+     -
+     -
 
 
 

doc/tutorials.rst

@@ -11,4 +11,4 @@ diffCheck tutorials
    pre-processing
    assembly_intro
    segmentation_intro
-   compute_error_intro
+   compute_error_intro