doc-cheat-sheet.rst

orphan:

ReStructuredText cheat sheet

This file contains the syntax for commonly used reST markup. Open it in your text editor to quickly copy and paste the markup you need.

See the reStructuredText style guide for detailed information and conventions.

Also see the Sphinx reStructuredText Primer for more details on reST, and the Canonical Documentation Style Guide for general style conventions.

H2 heading

:h2:`H2 heading without TOC entry`

H3 heading

H4 heading

H5 heading

Inline formatting

• :guilabel:`UI element`
• code
• :file:`file path`
• :command:`command`
• Key
• Italic
• Bold

Code blocks

Start a code block:

code:
  - example: true

# Demonstrate a code block
code:
  - example: true

# Demonstrate a code block
code:
  - example: true

Links

• Canonical website
• Canonical website (defined in reuse/links.txt or at the bottom of the page)
• https://canonical.com/
• :ref:`a_section_target`
• :ref:`Link text <a_section_target>`
• :doc:`index`
• :doc:`Link text <index>`

Navigation

Use the following syntax:

.. toctree::
   :hidden:

   sub-page1
   sub-page2

Lists

1. Step 1
   • Item 1
     • Sub-item
   • Item 2
     1. Sub-step 1
     2. Sub-step 2
2. Step 2
   1. Sub-step 1
      • Item
   2. Sub-step 2

Term 1:

Definition

Term 2:

Definition

Tables

Header 1	Header 2
Cell 1 Second paragraph	Cell 2
Cell 3	Cell 4

:center:`Header 1`	Header 2
Cell 1 Second paragraph	Cell 2
Cell 3	:center:`Cell 4`

Header 1	Header 2
Cell 1 Second paragraph	Cell 2
Cell 3	Cell 4

.. rst-class:: align-center

   +----------------------+------------+
   | Header 1             | Header 2   |
   +======================+============+
   | Cell 1               | Cell 2     |
   |                      |            |
   | Second paragraph     |            |
   +----------------------+------------+
   | Cell 3               | Cell 4     |
   +----------------------+------------+

Header 1	Header 2
Cell 1 Second paragraph	Cell 2
Cell 3	Cell 4

Notes

Note

A note.

Tip

A tip.

Important

Important information

Caution!

This might damage your hardware!

Images

Figure caption

Reuse

This is included text.

Tabs

.. tabs::

   .. group-tab:: Tab 1

      Content Tab 1

   .. group-tab:: Tab 2

      Content Tab 2

Glossary

.. glossary::

   example term
     Definition of the example term.

:term:`example term`

More useful markup

• .. versionadded:: X.Y
  

• Line 1

  Line 2

  Line 3

• :abbr:`API (Application Programming Interface)`

---

Custom extensions

Related links at the top of the page:

:relatedlinks: https://github.com/canonical/lxd-sphinx-extensions, [RTFM](https://www.google.com)
:discourse: 12345

Terms that should not be checked by the spelling checker: :spellexception:`PurposelyWrong`

A single-line terminal view that separates input from output:

.. terminal::
   :input: command
   :user: root
   :host: vampyr
   :dir: /home/user/directory/

   the output

A multi-line version of the same:

.. terminal::
   :user: root
   :host: vampyr
   :dir: /home/user/directory/

   :input: command 1
   output 1
   :input: command 2
   output 2

A link to a YouTube video:

.. youtube:: https://www.youtube.com/watch?v=iMLiK1fX4I0
          :title: Demo