... | @@ -29,7 +29,7 @@ Sub-sub-sub-section (last level) |
... | @@ -29,7 +29,7 @@ Sub-sub-sub-section (last level) |
|
|
|
|
|
All code must follow the sphinx grammar, for more information about the syntax, you can check the [sphinx reference documentation](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections)
|
|
All code must follow the sphinx grammar, for more information about the syntax, you can check the [sphinx reference documentation](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections)
|
|
|
|
|
|
Images and all graphics content, should be in png format, for any new top level section, the structure should be as follows:
|
|
For any new top-level section, the structure should be as follows:
|
|
|
|
|
|
```
|
|
```
|
|
.. toctree::
|
|
.. toctree::
|
... | @@ -40,6 +40,10 @@ Images and all graphics content, should be in png format, for any new top level |
... | @@ -40,6 +40,10 @@ Images and all graphics content, should be in png format, for any new top level |
|
/path/index
|
|
/path/index
|
|
```
|
|
```
|
|
|
|
|
|
|
|
if you need to add images to your section or the section you are updating, you should create a folder called `fig` inside the folder of the new or existing section, Images and all graphics content should be in png format.
|
|
|
|
|
|
|
|
Technical names such as variables or other relevant names should be enclosed with semicolons (example: ``structure_xxxx.db`` ).
|
|
|
|
|
|
|
|
|
|
## Generating and deploying a new version
|
|
## Generating and deploying a new version
|
|
|
|
|
... | | ... | |