Table of Contents for this page

Examples

Today’s date is 2019-08-07.

This document was generated on 2019-08-07 at 12:50.

  • A list of
  • short items
  • that should be
  • displayed
  • horizontally
environment
A structure where information about all documents under the root is saved, and used for cross-referencing. The environment is pickled after the parsing stage, so that successive runs only need to read and parse new and changed documents.
source directory
The directory which, including its subdirectories, contains all source files for one Sphinx project.
try_stmt  ::=  try1_stmt | try2_stmt
try1_stmt ::=  "try" ":" suite
               ("except" [expression ["," target]] ":" suite)+
               ["else" ":" suite]
               ["finally" ":" suite]
try2_stmt ::=  "try" ":" suite
               "finally" ":" suite

See also

Module zipfile
Documentation of the zipfile standard module.
GNU tar manual, Basic Tar Format
Documentation for tar archive files, including GNU tar extensions.
underline:This text is underlined

Welcome to the Windows installation page !

Note

This is a note box

Warning

This is a warning box

Danger

This is a danger box

Attention

This is a attention box

Caution

This is a caution box

Error

This is a error box

Hint

This is a hint box

Important

This is a important box

Tip

This is a tip box

And, by the way…

You can make up your own admonition too.

This is a heading

Single line syntax

italics

boldface

code examples

  • This is a bulleted list.
  • It has two items, the second item uses two lines.
  1. This is a numbered list.
  2. It has two items too.
  3. This is a numbered list.
  4. It has two items too.
  5. This is a numbered list.
  6. It has two items too.
  • this is
  • a list
    • with a nested list
    • and some subitems
  • and here the parent list continues

CNN Website

This is a typical paragraph. An indented literal block follows.

for a in [5,4,3,2,1]:   # this is program code, shown as-is
    print a
print "it's..."
# a literal block continues until the indentation ends

This text has returned to the indentation of the first paragraph, is outside of the literal block, and is therefore treated as an ordinary paragraph.

Frozen Delights!
Treat Quantity Description
Albatross 2.99 On a stick!
Crunchy Frog 1.49 If we took the bones out, it wouldn’t be crunchy, now would it?
Gannet Ripple 1.99 On a stick!
A B A and B
False False False
True False False
False True False
True True True
Header row, column 1 (header rows optional) Header 2 Header 3 Header 4
body row 1, column 1 column 2 column 3 column 4
body row 2  
These lines are
broken exactly like in
the source file.
This is a code block:

def my_function():
    "just a test"
    print 8/2

No matter where you go, there you are.

—Buckaroo Banzai

The ‘rm’ command is very dangerous. If you are logged in as root and enter

cd /
rm -rf *

you will erase the entire contents of your file system.

This paragraph might be rendered in a custom way.

rubric n. 1. a title, heading, or the like, in a manuscript, book, statute, etc., written or printed in red or otherwise distinguished from the rest of the text. …

A white-on-black theme for the Sphinx documentation generator. It has slightly muted white text on various shades of dark grey. I created this as I find light-on-dark themes typically easier on the eyes, since I tend to use dark backgrounds on my terminals and I don’t like flicking between light and dark backgrounds frequently.

Single-Indented Quoate: It uses a subtle text shadow and rounded corners to improve legibility, but it should also render accpetably on browsers which don’t support these CSS features.

Double-Indented Quoate: It uses a subtle text shadow and rounded corners to improve legibility, but it should also render accpetably on browsers which don’t support these CSS features.

It uses a subtle text shadow and rounded corners to improve legibility, but it should also render accpetably on browsers which don’t support these CSS features.

The theme should cover most common constructions, but it’s possible there are some classes I’ve missed. It also includes a Pygments theme which I think complements it without being overly bright.

term (up to a line of text)

Definition of the term, which must be indented

and can even consist of multiple paragraphs

next term
Description.

Single line2 syntax

Topic Title

Subsequent indented lines comprise the body of the topic, and are interpreted as body elements.

“To Ma Own Beloved Lassie: A Poem on her 17th Birthday”, by Ewan McTeagle (for Lassie O’Shea):

Lend us a couple of bob till Thursday.
I’m absolutely skint.
But I’m expecting a postal order and I can pay you back
as soon as it comes.
Love, Ewan.