-
Notifications
You must be signed in to change notification settings - Fork 5
/
RST-Template.rst
74 lines (57 loc) · 1.66 KB
/
RST-Template.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
Title
======
Header
-------
Sub Header 1
~~~~~~~~~~~~~
Sub Header 2
-------------
Sub Header 3
`````````````
.. image: images/holderimage.png
:align: center, left, right
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 [#f1]_ and second item [#f2]_.
.. rubric:: Footnotes
.. [#f1] My first footnote.
.. [#f2] My second footnote.
Tables
======
Here are some examples of Sphinx
`tables <http://sphinx-doc.org/rest.html#rst-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:
.. cssclass:: table-bordered
+------------------------+------------+----------+----------+
| Header1 | Header2 | Header3 | Header4 |
+========================+============+==========+==========+
| row1, cell1 | cell2 | cell3 | cell4 |
+------------------------+------------+----------+----------+
| row2 ... | ... | ... | |
+------------------------+------------+----------+----------+
| ... | ... | ... | |
+------------------------+------------+----------+----------+
Credits to:
https://ryan-roemer.github.io/sphinx-bootstrap-theme/examples.html