|
|
## 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.
|
|
|
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:
|
|
|
|
|
|
The source code for the user guide is located in the following location of the Autosubmit source code tree:
|
|
|
|
|
|
`autosubmit/docs/source/database`
|
|
|
`autosubmit/docs/source/`
|
|
|
|
|
|
All user guides and technical aspects of the application that concerns usage, development and deployment are described there.
|
|
|
|
|
|
|
|
|
## Adding/updating a section
|
|
|
|
|
|
## Generating and deploying a new version |
|
|
\ No newline at end of file |
|
|
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:
|
|
|
|
|
|
|
|
|
```
|
|
|
Section name (This is the name that will be displayed at the navigation bar)
|
|
|
============
|
|
|
|
|
|
Sub-section (depending on the maxdepth of the toctree, this will appear as a subsection on the navbar)
|
|
|
-----------
|
|
|
|
|
|
Sub-sub-section
|
|
|
~~~~~~~~~~~~~~~
|
|
|
|
|
|
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)
|
|
|
|
|
|
Images and all graphics content, should be in png format, for any new top level section, the structure should be as follows:
|
|
|
|
|
|
```
|
|
|
.. toctree::
|
|
|
:caption: <Section title>
|
|
|
:maxdepth: 1
|
|
|
:hidden:
|
|
|
|
|
|
/path/index
|
|
|
```
|
|
|
|
|
|
|
|
|
## Generating and deploying a new version
|
|
|
|
|
|
Readthedocs is prepared to trigger the build of the latest version pushed to the master branch for v4.0.0b and v3.14.0 automatically whenever there is a new commit on the git repository.
|
|
|
|
|
|
Usually, the building process takes 5 minutes, and to check that effectively the changes were taken into account in the last build, you should do a full refresh of the webpage with control + f5 in the web browser to see the changes reflected.
|
|
|
|
|
|
It is also possible to make a manual build, for such purpose you need admin access to https://readthedocs.org/projects/autosubmit/ project.
|
|
|
|