Source

sphinx / tests / root / markup.txt

Full commit
:tocdepth: 2

Testing various markup
======================

.. sectionauthor:: Georg Brandl

.. contents:: TOC

.. meta::
   :author: Me
   :keywords: docs, sphinx

.. _label:

::

   some code

Admonitions
-----------

.. note:: Note
   Note text.

.. warning:: Warning

   Warning text.

.. tip::
   Tip text.


Body directives
---------------

.. topic:: Title

   Topic body.

.. sidebar:: Sidebar
   :subtitle: Sidebar subtitle

   Sidebar body.

.. rubric:: Test rubric

.. epigraph:: Epigraph title

   Epigraph body.

   -- Author

.. highlights:: Highlights

   Highlights body.

.. pull-quote:: Pull-quote

   Pull quote body.

.. compound::

   a

   b

   
Tables
------

.. tabularcolumns:: |L|p{5cm}|R|

+----+----------------+----+
| 1  | * Block elems  |  x |
|    | * In table     |    |
+----+----------------+----+
| 2  | Empty cells:   |    |
+----+----------------+----+


Version markup
--------------

.. versionadded:: 0.5
   Some funny **stuff**.

.. versionchanged:: 0.5
   Even more funny stuff.

.. deprecated:: 0.4
   Boring stuff.


Misc stuff
----------

Stuff [#]_

Reference lookup: [Ref1]_ (defined in another file).

.. seealso:: something, something else, something more

   `Google <http://www.google.com>`_
       For everything.

.. rubric:: Side note

This is a side note.

This tests :CLASS:`role names in uppercase`.

Option list:

-h              help
--help          also help

.. centered:: LICENSE AGREEMENT

.. acks::

   * Terry Pratchett
   * J. R. R. Tolkien
   * Monty Python

.. glossary::

   boson
      Particle with integer spin.

   fermion
      Particle with half-integer spin.

.. productionlist::
   try_stmt: try1_stmt | try2_stmt
   try1_stmt: "try" ":" `suite`
            : ("except" [`expression` ["," `target`]] ":" `suite`)+
            : ["else" ":" `suite`]
            : ["finally" ":" `suite`]
   try2_stmt: "try" ":" `suite`
            : "finally" ":" `suite`


Index markup
------------

.. index::
   single: entry
   pair: entry; pair
   triple: index; entry; triple
   keyword: with

Invalid index markup...

.. index::
   single:
   pair:
   keyword:


Ö... Some strange characters
----------------------------

Testing öäü...


.. rubric:: Footnotes

.. [#] Like footnotes.