=============================================
How to use Restructured Text in Juicebox Docs
=============================================

.. contents::

Basic rules

- Wrap lines at 80 characters
- Full underlines for titles. The symbols you use define the levels.
- **EVERY** section title must be unique.
- Back ticks define a reference (either to a file or to another section heading.)
- Double back ticks for inline code.

Section headings
================

The header levels are not predefined. Any text with a consistent underline or 
overline at least as long as the content will define a header level. You can 
use any of the following.

.. code-block:: none

    ==============
    header level 1
    ==============

    header level 2
    ==============

    header level 3
    --------------

    header level 4
    ^^^^^^^^^^^^^^




How to build links
==================

Enclose either a file name or a section title in back ticks to create a link.

Referring to documents
----------------------

:doc:`/topics/juicebox_reference/slices/global_filters` an absolute reference to a ``:doc:``

`/topics/juicebox_reference/slices/global_filters` is an absolute reference using a default role

Referring to sections
---------------------

:ref:`Orbit config` is a ``:ref:`` reference using a section title

`Orbit config` is a shortcut section title.

Referring to terms
------------------

:term:`App` is glossary reference

Code blocks
===========

Here's a block of code. 

- The only required element is language ``.. code-block:: {language}``
- Code must be valid in the language you've chosen, choose ``none`` if in doubt.

.. code-block:: none
     :linenos:
     :emphasize-lines: 3,5
     :caption: An example code-block with everything turned on.
     :name: Full code-block example

     # Comment line
     import System
     System.run_emphasis_line
     # Long lines in code blocks create a auto horizontal scrollbar
     System.exit!

.. code-block:: python

    class SharedBase(RecipeServiceBaseV3):
        """Shared stack logic is defined here."""

        def __init__(self, *args, **kwargs):
            super(SharedBase, self).__init__(*args, **kwargs)
            self.user_filter_table = None