mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
272 lines
3.6 KiB
Plaintext
272 lines
3.6 KiB
Plaintext
:tocdepth: 2
|
|
|
|
.. title:: set by title directive
|
|
|
|
Testing various markup
|
|
======================
|
|
|
|
Meta markup
|
|
-----------
|
|
|
|
.. sectionauthor:: Georg Brandl
|
|
.. moduleauthor:: Georg Brandl
|
|
|
|
.. contents:: TOC
|
|
|
|
.. meta::
|
|
:author: Me
|
|
:keywords: docs, sphinx
|
|
|
|
|
|
Generic reST
|
|
------------
|
|
|
|
A |subst| (the definition is in rst_epilog).
|
|
|
|
.. _label:
|
|
|
|
::
|
|
|
|
some code
|
|
|
|
Option list:
|
|
|
|
-h help
|
|
--help also help
|
|
|
|
|
|
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
|
|
|
|
|
|
Admonitions
|
|
^^^^^^^^^^^
|
|
|
|
.. admonition:: My Admonition
|
|
|
|
Admonition text.
|
|
|
|
.. note::
|
|
Note text.
|
|
|
|
.. warning::
|
|
|
|
Warning text.
|
|
|
|
.. tip::
|
|
Tip text.
|
|
|
|
|
|
Inline markup
|
|
-------------
|
|
|
|
*Generic inline markup*
|
|
|
|
* :command:`command`
|
|
* :dfn:`dfn`
|
|
* :guilabel:`guilabel`
|
|
* :kbd:`kbd`
|
|
* :mailheader:`mailheader`
|
|
* :makevar:`makevar`
|
|
* :manpage:`manpage`
|
|
* :mimetype:`mimetype`
|
|
* :newsgroup:`newsgroup`
|
|
* :program:`program`
|
|
* :regexp:`regexp`
|
|
* :menuselection:`File --> Close`
|
|
* :file:`a/{varpart}/b`
|
|
* :samp:`print {i}`
|
|
|
|
*Linking inline markup*
|
|
|
|
* :pep:`8`
|
|
* :rfc:`1`
|
|
* :envvar:`HOME`
|
|
* :keyword:`with`
|
|
* :token:`try statement <try_stmt>`
|
|
* :doc:`subdir/includes`
|
|
* ``:download:`` is tested in includes.txt
|
|
* :option:`Python -c option <python -c>`
|
|
|
|
Test :abbr:`abbr (abbreviation)` and another :abbr:`abbr (abbreviation)`.
|
|
|
|
|
|
.. _with:
|
|
|
|
With
|
|
----
|
|
|
|
(Empty section.)
|
|
|
|
|
|
Tables
|
|
------
|
|
|
|
.. tabularcolumns:: |L|p{5cm}|R|
|
|
|
|
+----+----------------+----+
|
|
| 1 | * Block elems | x |
|
|
| | * In table | |
|
|
+----+----------------+----+
|
|
| 2 | Empty cells: | |
|
|
+----+----------------+----+
|
|
|
|
|
|
Version markup
|
|
--------------
|
|
|
|
.. versionadded:: 0.6
|
|
Some funny **stuff**.
|
|
|
|
.. versionchanged:: 0.6
|
|
Even more funny stuff.
|
|
|
|
.. deprecated:: 0.6
|
|
Boring stuff.
|
|
|
|
|
|
Code blocks
|
|
-----------
|
|
|
|
.. code-block:: ruby
|
|
:linenos:
|
|
|
|
def ruby?
|
|
false
|
|
end
|
|
|
|
|
|
Misc stuff
|
|
----------
|
|
|
|
Stuff [#]_
|
|
|
|
Reference lookup: [Ref1]_ (defined in another file).
|
|
|
|
.. seealso:: something, something else, something more
|
|
|
|
`Google <http://www.google.com>`_
|
|
For everything.
|
|
|
|
.. hlist::
|
|
:columns: 4
|
|
|
|
* This
|
|
* is
|
|
* a horizontal
|
|
* list
|
|
* with several
|
|
* items
|
|
|
|
.. rubric:: Side note
|
|
|
|
This is a side note.
|
|
|
|
This tests :CLASS:`role names in uppercase`.
|
|
|
|
.. 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
|
|
double: entry; double
|
|
triple: index; entry; triple
|
|
keyword: with
|
|
|
|
Invalid index markup...
|
|
|
|
.. index::
|
|
single:
|
|
pair:
|
|
keyword:
|
|
|
|
|
|
Ö... Some strange characters
|
|
----------------------------
|
|
|
|
Testing öäü...
|
|
|
|
|
|
Only directive
|
|
--------------
|
|
|
|
.. only:: html
|
|
|
|
In HTML.
|
|
|
|
.. only:: latex
|
|
|
|
In LaTeX.
|
|
|
|
.. only:: html or latex
|
|
|
|
In both.
|
|
|
|
.. only:: confpytag and (testtag or nonexisting_tag)
|
|
|
|
Always present, because set through conf.py/command line.
|
|
|
|
|
|
.. rubric:: Footnotes
|
|
|
|
.. [#] Like footnotes.
|
|
|