Tutorial Template#

Two Tutorial Template copy options are available:

  1. Copy a tutorial template with some examples and hints in each section to help you get started.

  2. Copy an empty tutorial template framework.

Use the copy button and paste the tutorial template into your new tutorial.

See the rst code in Template with Examples rendered here.

Important

The highlighted items are the template parts to modify for your use case.

Examples provided in the Tutorial body are for demonstration purposes.

Delete any examples that you wish to.

Highlighted lines require author input.#
 1.. include:: /extras.rst.txt
 2.. highlight:: rst
 3.. index:: template-tutorial ; Index
 4
 5
 6.. _template-tutorial:
 7================
 8Name of Tutorial
 9================
10
11|
12
13A brief description about the tutorials aims.
14
15.. admonition:: Example - Using Admonitions
16
17    Use notes to bring something to the user's attention where it improves
18    user experience.
19
20    See `Write a tutorial using Diataxis <https://junction-box.readthedocs.io/en/
21    latest/Document-Framework/diataxis-tutorials.html>`_
22    for assistance on how to write a well-structured tutorial.
23
24|
25
26Pre-requisites
27==============
28
29Examples of pre-requisites
30
31`Python 3.6 <https://www.python.org/downloads/>`_ or greater installed on
32your computer.
33
34:ref:`Create an index page.<template-index>`
35
36
37.. _the-name-tutorial:
38Tutorial
39========
40
41
42
43.. _first-step-title:
44First Step Title
45----------------
46
47Select the tab for your preferred Operating System.
48
49.. admonition:: Example - Using Admonitions
50
51    You can use numbered step headings; however, well-described titles appear
52    to flow in the TOC.
53
54    Using Tabs can condense the page and group logical items together,
55    for example, different Operating Systems have various commands
56    to achieve the same outcome.
57
58    See this example below.
59
60.. tab:: Linux
61
62    Do some linux command.
63
64.. tab:: macOS
65
66    Do some macOS command.
67
68.. tab:: Windows
69
70    Do some Windows command.
71
72Whats next?
73-----------
74
75.. hint::
76
77    Here you can guide the user to expand their knowlege with relevant
78    information.
79
80    For example:
81
82    See `Diataxis Introduction <https://junction-box.readthedocs.io/en/latest/Document-Framework/diataxis-intro.html>`_
83    for more information about writing documentation.
Highlighted lines require author input.#
 1.. include:: /extras.rst.txt
 2.. highlight:: rst
 3.. index:: template-tutorial ; Index
 4
 5
 6.. _template-tutorial:
 7================
 8Name of Tutorial
 9================
10
11|
12
13A brief description about the tutorials aims.
14
15|
16
17Pre-requisites
18==============
19
20|
21
22.. _the-name-tutorial:
23Tutorial
24========
25
26|
27
28.. _first-step-title:
29First Step Title
30----------------
31
32|
33
34Whats next?
35-----------