The contents of each rST file begins with a Title, formatted with = signs above and below the words and spaces in the title.
There must be as many = signs as there are words and spaces.
This syntax produces this title in the Kylo Read-the-Docs site:
The Kylo documentation uses the following heading syntax to produce the following outputs:
Add two asterisks before and after the word you wish to boldface. For example:
**Setup Wizard**
The :doc: directive can be used to create a link to another document in the Kylo RTD library:
In the Kylo RTD output, this directive produces this (see the link embedded in the paragraph):
When the user clicks the Setup Wizard Deployment Guide link, the document opens in a new tab in the browser.
External links are done using the raw syntax, which opens the link in a separate tab, leaving the Read the Docs page open.:
That link syntax can be used standalone code, or it can be embedded in text as in the following example. Either way, it produces the same output in the Kylo RTD site.
Notice how the above rst syntax displays in the Kylo RTD site.
This syntax requires that the link be specified with the following rst syntax, which is included at the bottom of the rst source file:
Bulleted lists may be indented or not, using this sample syntax:
The above syntax produces this output:
A variety of special formats are available through one-word directives, each of which produces a box (examples) below with a color scheme determined by the theme. (Note that Kylo uses the RTD Theme.)
Starting flush left, the directive is stated as in this example:
This produces the following note:
Changing the key word (e.g., note, error, important, tip, waring) changes the output, as shown in the following examples:
Various code-block directives produce different results, highlighting words in ways appropriate to how the code-block is assigned (e.g., shell, properties, javascript, html)
Here is a code-block for standard coding, and the way it displays on the Kylo RTD site:
And here is code-block for displaying code properties:
And here is code-block for displaying inline code, as shown below:
