Examples¶

Various examples of Bootstrap styling applied to Sphinx constructs. You can view the source of this page to see the specific reStructuredText used to create these examples.

Headings¶

This is a first level heading (h1).

Sub-Heading¶

This is a second level heading (h2).

Sub-Sub-Heading¶

This is a third level heading (h3).

Code¶

The Sphinx Bootstrap Theme uses Bootstrap styling for inline code text and

multiline
code text

Here’s an included example with line numbers.

"""Sphinx bootstrap theme."""
import os

__version__ = "0.8.1"


def get_html_theme_path():
    """Return list of HTML theme paths."""
    theme_path = os.path.abspath(os.path.dirname(__file__))
    return [theme_path]


def setup(app):
    """Setup."""
    # add_html_theme is new in Sphinx 1.6+
    if hasattr(app, 'add_html_theme'):
        theme_path = get_html_theme_path()[0]
        app.add_html_theme('bootstrap', os.path.join(theme_path, 'bootstrap'))

It also works with existing Sphinx highlighting:

<html>
  <body>Hello World</body>
</html>

def hello():
    """Greet."""
    return "Hello World"

/**
 * Greet.
 */
function hello(): {
  return "Hello World";
}

Admonitions¶

The Sphinx Bootstrap Theme uses the Bootstrap alert classes for Sphinx admonitions.

Note¶

Note

This is a note.

Todo¶

Todo

This is a todo.

Warning¶

Warning

This is a warning.

Danger¶

Danger

This is danger-ous.

Footnotes¶

I have footnoted a first item 1 and second item 2. This also references the second item 2.

Footnotes

1: My first footnote.
2(1,2): My second footnote.

Icons¶

Icons are different in Bootstrap 2 and 3, so you will only see an icon below for the version of Bootstrap that we used to build these docs.

Bootstrap 2¶

The following template HTML:

<span class="icon-star-empty"></span>

translates to a neat star:

Bootstrap 3¶

The following template HTML:

<span class="glyphicon glyphicon-star-empty"></span>

translates to a neat star:

Tables¶

Here are some examples of Sphinx tables. The Sphinx Bootstrap Theme removes all Sphinx docutils classes and replaces them with the default Bootstrap table class. You can add additional table classes using the Sphinx cssclass:: directive, as demonstrated in the following tables.

Grid¶

A “bordered” grid table:

Header1	Header2	Header3	Header4
row1, cell1	cell2	cell3	cell4
row2 …	…	…
…	…	…

which uses the directive:

.. cssclass:: table-bordered

Simple¶

A simple “striped” table:

H1	H2	H3
cell1	cell2	cell3
…	…	…
…	…	…

which uses the directive:

.. cssclass:: table-striped

And a “hoverable” table:

H1	H2	H3
cell1	cell2	cell3
…	…	…
…	…	…

which uses the directive:

.. cssclass:: table-hover

Code Documentation¶

An example Python function.

format_exception(etype, value, tb[, limit=None])¶

Format the exception with a traceback.

Parameters

etype – exception type
value – exception value
tb – traceback object
limit (int or None) – maximum number of stack frames to show

Return type

list[str]

An example C++ function.

int foo(bool use_random = false)¶

Parameters: use_random – Whether or not to return a random number.
Returns: 42 if use_random == false, a random number otherwise.