See also
http://www.sphinx-doc.org/en/stable/rest.html, http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html, http://packages.python.org/an_example_pypi_project/sphinx.html
Referring to a page in the docs with custom link text Talk to us please!
Otherwise it will use the name of the document by default Contact us
Look nicer than plain inserted images as they have a bounding box. They do not work well with left or right align.
To specify below the title of a page when a new feature was added, use:
.. versionadded:: 1.1
A | B |
---|---|
Led Cepin | music |
Hugh Laurie | television |
Simple table:
Inputs | Output | |
---|---|---|
A | B | A or B |
False | False | False |
True | False | True |
False | True | True |
True | True | True |
Footnotes provide extra information where using an info box is not appropriate [1]
[1] | Like here, the text is relevant only to the line here, not the whole page say. |
This is a normal text paragraph. The next paragraph is a code sample
/* Type here */
Widget = {
hide: function() {
return this.element
.animate({opacity: 0.0, top: -10});
},
show: function() {
return this.element
.animate({opacity: 1.0, top: 0});
},
element: $(".widget")
}
This is a normal text paragraph again followed by some CoffeeScript.
# Type here
Scope::find = (name, options) ->
return true if @check(name, options)
@add name, "var"
false
Note
Refer to mine with as MINE_NAME
Warning
All bash code blocks should start with $
The index page (link top right) is generated automatically using the keywords set on each page:
.. index:: keyword, another keyword
Entire document not appearing? Lines beginning with whitespace are invalid and can cause this error. Comb through your document and check things like headings to make sure they’re manually trimmed.
This would be a bad heading because it starts with a space
===========================================================
.,,.
,;;*;;;;,
.-'``;-');;.
/' .-. /*;;
.' \d \;; .;;;,
/ o ` \; ,__. ,;*;;;*;,
\__, _.__,' \_.-') __)--.;;;;;*;;;;,
`""`;;;\ /-')_) __) `\' ';;;;;;
;*;;; -') `)_) |\ | ;;;;*;
;;;;| `---` O | | ;;*;;;
*;*;\| O / ;;;;;*
;;;;;/| .-------\ / ;*;;;;;
;;;*;/ \ | '. (`. ;;;*;;;
;;;;;'. ; | ) \ | ;;;;;;
,;*;;;;\/ |. / /` | ';;;*;
;;;;;;/ |/ / /__/ ';;;
'*jgs/ | / | ;*;
`""""` `""""` ;'