Sphinx Quick Reference

注解

Your note should consist of one or more paragraphs, all indented so that they clearly belong to the note and not to the text or directive that follows.

Many other directives are also supported, including: warning, versionadded, versionchanged, seealso, deprecated, rubric, centered, hlist, glossary, productionlist.

/* Or say "highlight::" once to set the language for all of the
   code blocks that follow it.  Options include ":linenos:",
   ":linenothreshold:", and ":emphasize-lines: 1,2,3". */

char s[] = "You can also say 'python', 'ruby', ..., or 'guess'!";

class httplib.Request

Zero or more paragraphs of introductory material for the class.

send()

Description of the send() method.

url

Description of the url attribute.

Many more members are possible than just method and attribute, and non-Python languages are supported too; see the Sphinx docs for more possibilities!

print 'The doctest extension supports code without >>> prompts!'

The doctest extension supports code without >>> prompts!

This paragraph can be targeted with custom-label, and will also be the target of several index entries!

This paragraph will be listed in the index under both “wire, copper” and “copper, wire.” See the Sphinx documentation for even more complex ways of building index entries.

Many kinds of cross-reference can be used inside of a paragraph:

custom-label class quick-sphinx :method:`~module.class.method()` module :attr: ~module.class.attribute

(See the Sphinx “Inline Markup” chapter for MANY more examples!)