Cheatsheet

Look at the raw version of this file to compare the source and build version: sphinx_cheatsheet.rst

The first lines of this page will also be explained later on in this document (see Links and Titles)

Moderate emphasis

Strong emphasis

This is text in Courier

This is plain text.

In general: avoid acronyms. When you want to use them, the first occurrence on a page should explain them: CephFS (Ceph Filesystem). Sphinx supports a :abbr: tag, see http://www.sphinx-doc.org/en/stable/markup/inline.html#other-semantic-markup. Here’s a test: CephFS

or

SURFsara website (see bottom of the document; that is were we tell Sphinx were SURFsara website should point to)

This is an implicit link to title:

Internal wiki link:

Reference tag: place above a title: .. _my-reference-label:

Then refer to it from another page as. For example, for this cheatsheet: Cheatsheet or ref:other label <cheatsheet>

H1: document title

And some text.

or

Warning

This is a warning box.

Note

This is a note box.

Tip

This is a tip box.

Error

This is an error box.

See also

This is a simple seealso note.

path/to/myfile.txt

When you want to display commands, output and comments, use .. code-block:: bash. Prefix commands with a $ and prefix comments with ##, otherwise they are marked up as a command. Example:
```
$echo 'Hello World!'
Hello World!
## Comments should be prefixed with a double ``#``.
```
When you want to display commands and comments, use .. code-block:: bash. Don’t prefix commands. Example:
# [homer@htp-ui ~]$ is the first prompt upon login ssh [USERNAME]@[Spider HOSTNAME]
You can add line numbers to code examples with the :linenos: parameter.

# [homer@htp-ui ~]$ is the first prompt upon login
ssh [USERNAME]@[Spider HOSTNAME]