The Cloud Sphinx Theme documentation has moved to https://cloud-sptheme.readthedocs.io

Feature Test

This page contains examples of various features of the Cloud theme. It’s mainly useful internally, to make sure everything is displaying correctly.

Inline Text

Inline literal: literal text.

Samp literal: this is a variable, these are literal { and }.

External links are prefixed with an arrow: http://www.google.com.

But email links are not prefixed: bob@example.com.

Issue tracker link: issue 5.

This text should be crossed out

Admonition Styles

Note

This is a note.

Caution

This is a 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 XXX: This is a deprecation warning.

New in version XXX: This was added

Changed in version XXX: This was changed

Note

This is note using the float-right class.

Note

This is note using the float-center class.

See also

This is a “see also” using the without-title class.

Code Styles

Python Code Block:

1
2
3
4
5
6
7
8
9
>>> import os

>>> os.listdir("/home")
['bread', 'pudding']

>>> os.listdir("/root")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
OSError: [Errno 13] Permission denied: '/root'

INI Code Block:

1
2
3
4
[rueben]
bread = rye
meat = corned beef
veg = sauerkraut

Long Lines (issue 22):

1
2
3
4
0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ


0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ

Function styling:

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

Class styling:

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

Class docstring. Saying things.

foo

foobinate strength

bar

barring enabled

run()

execute action, return result.

Table Styles

Normal Table
Header1 Header2 Header3
Row 1 Row 1 Row 1
Row 2 Row 2 Row 2
Row 3 Row 3 Row 3
Plain Table (no row shading)
Header1 Header2 Header3
Row 1 Row 1 Row 1
Row 2 Row 2 Row 2
Row 3 Row 3 Row 3
Centered Table
Header1 Header2 Header3
Row 1 Row 1 Row 1
Row 2 Row 2 Row 2
Row 3 Row 3 Row 3
Full Width Table
Header1 Header2 Header3
Row 1 Row 1 Row 1
Row 2 Row 2 Row 2
Row 3 Row 3 Row 3
Table Styling Extension
Width x1 Width x2 Width x3
Header 1 Center 1 Right 1
Header 2 Center 2 Right 2
Header 3 Center 3 Right 3
Table Styling Extension – header alignment & colspans
Left x1 Right x1 Left x1 Right x1 Left x2 Right x2 Left x4 Right x4
Left Span x1+1 Center Span x1+1+2+2 Center Span x4+4
Center Span xALL
Center Span xALL
Table Styling Extension – multi-row header + header columns
Left x1 Right x1 Left x1 Right x1 Left x2 Right x2 Left x4 Right x4
Left Span x1+1 Center Span x1+1+2+2 Center Span x4+4
H x1 x1 Center Span x1+1 Center Span x2+2 Center Span x4+4
H x1 Center Span xALL

Toggleable Section

This section is collapsed by default. But if a visitor follows a link to this section or something within it (such as this), it will automatically be expanded.

Toggleable Subsection

Subsections can also be marked as toggleable. This one should be expanded by default.

Normal Section

Child Section

Toggleable Subsection

Test of emphasized + toggleable styles. Should be collapsed by default.

Section With Emphasized Children

Mainly useful for sections with many long subsections, where a second level of visual dividers would be useful.

Child Section

Should have slightly lighter background, and be indented.

Toggleable Subsection

Test of emphasized + toggleable styles. Should be collapsed by default.

autodoc_sections Extension

cloud_sptheme.ext.autodoc_sections._doctestfunc()

The autodoc_sections extension should generate nested sections as found within object docstrings.

Nested Section

Parameters:arg – xxx
foo

bar

These sections can in turn contain others:

Child Section

Which allows breaking long class docstrings up in meaningful ways.

Child Section 2

And more content

Nested Section 2

end of class