Skip to content

Commit b3654d3

Browse files
updates the guide_lines_tutorials.rst
1 parent 1ee2a9f commit b3654d3

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

doc/source/getting_started/write_doc/guide_lines_tutorials.rst

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,30 @@ The new folder must contain at least a ``index.rst`` file. This file has:
100100
101101
tutorial_file.rst
102102
103-
You must also add the ``index.rst`` file in the main user guide page toctree. You can find it at the end of
104-
``doc/source/user_guide/index.rst`` file.
103+
You must also add the new section ``index.rst`` file in the main user guide page toctree. You can find this toctree
104+
at the end of ``doc/source/user_guide/index.rst`` file.
105+
106+
.. code-block::
107+
108+
.. toctree::
109+
:maxdepth: 2
110+
:hidden:
111+
:caption: Tutorials
112+
113+
tutorials/data_structures/index.rst
114+
tutorials/language_and_usage/index.rst
115+
tutorials/post_processing_basics/index.rst
116+
tutorials/import_data/index.rst
117+
tutorials/mesh/index.rst
118+
tutorials/transform_data/index.rst
119+
tutorials/export_data/index.rst
120+
tutorials/plot/index.rst
121+
tutorials/animate/index.rst
122+
tutorials/enriching_dpf_capabilities/index.rst
123+
tutorials/distributed_files/index.rst
124+
tutorials/dpf_server/index.rst
125+
tutorials/licensing/index.rst
126+
tutorials/new_section/index.rst
105127
106128
.. _ref_guide_lines_add_new_tutorial:
107129

@@ -162,9 +184,6 @@ This first part is essential for clarity, organization and usability of the tuto
162184
purpose, making it easy to understand what is going to be explained and reference it within the other parts of
163185
the documentation.
164186

165-
Components
166-
~~~~~~~~~~
167-
168187
The preamble must have the following components:
169188

170189
- File reference name;

0 commit comments

Comments
 (0)