5. Output Examples¶
5.1. Figures¶
The output below was generated from figures included within this document.
5.1.1. List (Default)¶
.. list-items:: figures
5.1.2. Table¶
.. list-items:: figures
:table:
Section |
Id |
Anchor |
Caption |
File |
---|---|---|---|---|
specimens |
4.1 |
This is an example figure in a parent section |
640x400.png |
|
4.1 |
4.2 |
This is an example figure in subsection 1. |
200x200.png |
|
4.2.1 |
4.3 |
This is an example figure in subsection 2.1. |
300x200.png |
5.1.3. Custom Table¶
.. list-items:: figures
:table: id, caption
Id |
Caption |
---|---|
4.1 |
This is an example figure in a parent section |
4.2 |
This is an example figure in subsection 1. |
4.3 |
This is an example figure in subsection 2.1. |
5.2. Tables¶
The output below was generated from tables included within this document.
5.2.1. List (Default)¶
.. list-items:: tables
5.2.2. Table¶
.. list-items:: tables
:table:
Section |
Id |
Anchor |
Caption |
---|---|---|---|
specimens |
4.1 |
(no caption) |
|
4.1 |
4.2 |
(no caption) |
|
4.2.1 |
4.3 |
(no caption) |
5.2.3. Custom Table¶
.. list-items:: tables
:table: id, caption
Id |
Caption |
---|---|
4.1 |
(no caption) |
4.2 |
(no caption) |
4.3 |
(no caption) |
5.3. Versions¶
The following examples demonstrate listing Sphinx version directives, table/list output, version filtering, and custom columns.
5.3.1. List (Default)¶
.. list-items:: versionadded
:list:
.. list-items:: versionchanged
:list:
.. list-items:: deprecated
:list:
.. list-items:: versionremoved
:list:
5.3.2. Table¶
.. list-items:: versionadded
:table:
Docname |
Version |
Text |
Type |
---|---|---|---|
installation |
1.0.0 |
Initial Release |
versionadded |
specimens |
1.0.0 |
Initial Release |
versionadded |
specimens |
0.0.2 |
Example addition under a different version |
versionadded |
5.3.3. Filtered Table¶
.. list-items:: versionadded
:table:
:version: 0.0.2
Docname |
Version |
Text |
Type |
---|---|---|---|
specimens |
0.0.2 |
Example addition under a different version |
versionadded |
5.3.4. Custom Table¶
.. list-items:: versionchanged
:table: version, text
Version |
Text |
---|---|
1.0.0 |
Initial Release, example change |