Sphinx specific stuff

note

Note

This function is not suitable for sending spam e-mails.

warning

Warning

This function causes radioactive leaks and kills puppies.

versionadded

New in version 2.5: The spam parameter.

versionchanged

Changed in version 2.6: Now sends all spam back to sender.

deprecated

Deprecated since version 3.1: Use spam() instead.

seealso

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.

rubric

Rubric title

centered

LICENSE AGREEMENT

hlist

  • A list of
  • short items
  • that should be
  • displayed
  • horizontally

glossary

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.

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

code-block

def some_function():
    interesting = False
    print 'This line is highlighted.'
    print 'This one is not...'
    print '...but this one is.'

abbr

Example: LIFO.

command

The name of an OS-level command, such as rm or rm -Rf /

dfn

Mark the defining instance of a term in the text. (No index entries are generated.)

guilabel

An accelerator key for the GUI label can be included using an ampersand; this will be stripped and displayed underlined in the output (example: Cancel)

kbd

the same sequence should be marked as Control-x Control-f

mailheader

example: Content-Type

manpage

A reference to a Unix manual page including the section, e.g. ls(1).

sectionauthor