|
## Introduction
|
|
## Introduction
|
|
|
|
|
|
Autosubmit [user guide and documentation](https://autosubmit.readthedocs.io/en/master/) is currently hosted in ReadTheDocs.io platform, The documentation is compiled after new sections and updates are pushed to the master branch. The source code for the user guide is located in the following location of the Autosubmit source code tree:
|
|
Autosubmit [user guide and documentation](https://autosubmit.readthedocs.io/en/master/) is currently hosted in ReadTheDocs.io platform. [This tool](https://docs.readthedocs.io/en/stable/index.html) builds automatically a web page, pdf, and many other formats of the documentation after every push to watched branch.
|
|
|
|
|
|
|
|
The source code for the user guide is located in the following location of the Autosubmit source code tree:
|
|
|
|
|
|
`autosubmit/docs/source/`
|
|
`autosubmit/docs/source/`
|
|
|
|
|
... | @@ -9,8 +11,9 @@ All user guides and technical aspects of the application that concerns usage, de |
... | @@ -9,8 +11,9 @@ All user guides and technical aspects of the application that concerns usage, de |
|
|
|
|
|
## Adding/updating a section
|
|
## Adding/updating a section
|
|
|
|
|
|
To add any new content or update an existing one, first create a new branch (based on the master branch) and perform the needed changes, all new files should be with rst extension and follow the structure defined in the code, paid special attention to indentation since these can cause issues on the compilation. the format for the tree structure of the sections should follow the following convention:
|
|
To add any new content or update an existing one, first create a new branch (based on the master branch) and perform the needed changes, all new pages have to be ReStructuredText `.rst` files and be hierarchically placed in the folder structure.
|
|
|
|
|
|
|
|
After that, in order to properly show in the navigation bar of the web page, every new section, and its subsections, have to be included in the root `docs/sources/index.rst` table of content. Also you have to use the following syntax when defining sections:
|
|
|
|
|
|
```
|
|
```
|
|
Section name (This is the name that will be displayed at the navigation bar)
|
|
Section name (This is the name that will be displayed at the navigation bar)
|
... | @@ -26,21 +29,9 @@ Sub-sub-sub-section (last level) |
... | @@ -26,21 +29,9 @@ 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)
|
|
|
|
|
|
For any new top-level section, the structure should be as follows:
|
|
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.
|
|
|
|
|
|
```
|
|
|
|
.. toctree::
|
|
|
|
:caption: <Section title>
|
|
|
|
:maxdepth: 1
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
/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, for example:
|
|
Technical names such as variables or other relevant names should be enclosed with semicolons, for example:
|
|
|
|
|
... | | ... | |