Note

This documentation is for a development version. Click here for the latest stable release (v1.2.2).

Style tests

This page contains examples of the styles used in the Nengo theme. It is mainly useful for internal testing to make sure everything is displaying correctly. This page is based on the Cloud Sphinx theme’s feature test.

Heading

Sub-heading

Sub-sub-heading

Sub-sub-sub-heading

Text

Inline literal: literal text

External link: https://www.nengo.ai/

Email link: bob@example.com

Bold text

Italic text

Sphinx reference: FrobClass

Math

Inline math: \(a^2 + b^2 = c^2\)

Displayed math, with a label:

(1)\[e^{i\pi} + 1 = 0\]

Equation reference: (1)

Admonitions

Note

This is a note.

Caution

This is slightly dangerous.

Warning

This is a warning.

Danger

This is dangerous.

See also

This is a “see also” message.

Todo

This is a todo message.

With some additional next on another line.

Deprecated since version 0.1: This is a deprecation warning.

New in version 0.1: This was added.

Changed in version 0.1: This was changed.

Code

Python code block with line numbers:

1>>> import os
2
3>>> os.listdir("/home")
4['bread', 'pudding']
5
6>>> os.listdir("/root")
7Traceback (most recent call last):
8  File "<stdin>", line 1, in <module>
9OSError: [Errno 13] Permission denied: '/root'

INI code block:

[reuben]
bread = rye
meat = corned beef
veg = sauerkraut

Documentation

Function:

frobfunc(foo=1, *, bar=False)
Parameters:

  • foo (int) – foobinate strength

  • bar (bool) – enabled barring.

Returns:

frobbed return

Return type:

str

Raises:

TypeError – if foo is out of range

Function documented with NumPyDoc:

npfrobfunc(foo=1, *, bar=False)
Parameters:
fooint

foobinate strength

barbool

enabled barring.

Barring requires a second paragraph.

Returns:
str

frobbed return

Raises:
TypeError

if foo is out of range

Class:

class FrobClass(foo=1, *, bar=False)

Class docstring. Saying things.

foo

foobinate strength

bar

barring enabled

run()

execute action, return result.

Tables

Table caption

Header1

Header2

Header3

Row 1

Row 1

Row 1

Row 2

Row 2

Row 2

Row 3

Row 3

Row 3