Skip to content

Latest commit

 

History

History
552 lines (502 loc) · 12.2 KB

File metadata and controls

552 lines (502 loc) · 12.2 KB

default-role (sphinx.directives.DefaultRole): .

. .

default-domain (sphinx.directives.DefaultDomain): .

. .

object (sphinx.directives.ObjectDescription): .

. <desc_signature classes="sig sig-object"> <desc_name classes="sig-name descname" xml:space="preserve"> something <desc_content> .

highlight (sphinx.directives.code.Highlight): .

. .

code-block (sphinx.directives.code.CodeBlock): .

:dedent:

    a=1

. <literal_block force="False" highlight_args="{}" language="default" xml:space="preserve"> a=1 .

sourcecode (sphinx.directives.code.CodeBlock): .

. <literal_block force="False" highlight_args="{}" language="default" xml:space="preserve"> .

SKIP: Tested in sphinx builds .

. <system_message level="2" line="1" source="notset" type="WARNING"> Include file '/srcdir/path/to/file' not found or reading it failed .

toctree (sphinx.directives.other.TocTree): .

. .

sectionauthor (sphinx.directives.other.Author): .

. .

moduleauthor (sphinx.directives.other.Author): .

. .

codeauthor (sphinx.directives.other.Author): .

. .

index (sphinx.directives.other.Index): .

. .

seealso (sphinx.directives.other.SeeAlso): .


a

. a .

tabularcolumns (sphinx.directives.other.TabularColumns): .

. <tabular_col_spec spec="spec"> .

centered (sphinx.directives.other.Centered): .

. text .

acks (sphinx.directives.other.Acks): .


- name

. <bullet_list bullet="-"> <list_item> name .

hlist (sphinx.directives.other.HList): .


- item

. <bullet_list> <list_item> item <bullet_list> .

only (sphinx.directives.other.Only): .

. .

SKIP: Tested in sphinx builds .

. .

figure (sphinx.directives.patches.Figure): .


*caption*

legend

.

caption legend .

SKIP: MockingError: MockState has not yet implemented attribute 'nested_list_parse' .

foo

. .

table (sphinx.directives.patches.RSTTable): .

:name: name

| a | b |
|---|---|
| 1 | 2 |

.

<title> title a b 1 2 .

table widths auto (sphinx.directives.patches.RSTTable): .

:name: name
:widths: auto

| a | b |
|---|---|
| 1 | 2 |

.

<title> title a b 1 2 .

table widths grid (sphinx.directives.patches.RSTTable): .

:name: name
:widths: grid

| a | b |
|---|---|
| 1 | 2 |

.

<title> title a b 1 2 .

table widths given (sphinx.directives.patches.RSTTable): .

:name: name
:widths: 1 2

| a | b |
|---|---|
| 1 | 2 |

.

<title> title a b 1 2 .

csv-table (sphinx.directives.patches.CSVTable): .


"Albatross", 2.99, "On a stick!"

.

Albatross 2.99 On a stick! .

list-table (sphinx.directives.patches.ListTable): .


* - item

.

item .

code (sphinx.directives.patches.Code): .


a

. <literal_block force="False" highlight_args="{}" language="python" xml:space="preserve"> a .

math (sphinx.directives.patches.MathDirective): .

. <math_block docname="index" label="True" nowrap="False" number="True" xml:space="preserve"> .

deprecated (sphinx.domains.changeset.VersionChange): .

. Deprecated since version 0.3. .

versionadded (sphinx.domains.changeset.VersionChange): .

. New in version 0.2. .

versionchanged (sphinx.domains.changeset.VersionChange): .

. Changed in version 0.1. .

glossary (sphinx.domains.std.Glossary): .


term 1 : A
term 2 : B
    Definition of both terms.

. <definition_list classes="glossary"> <definition_list_item> term 1 term 2 Definition of both terms. .

SPHINX4-SKIP productionlist (sphinx.domains.std.ProductionList): .

. try1_stmt | try2_stmt .

cmdoption (sphinx.domains.std.Cmdoption): .

. <desc_signature allnames="a" classes="sig sig-object" ids="cmdoption-arg-a"> <desc_name classes="sig-name descname" xml:space="preserve"> a <desc_addname classes="sig-prename descclassname" xml:space="preserve"> <desc_content> .

rst:directive (sphinx.domains.rst.ReSTDirective): .

. <desc_signature classes="sig sig-object" ids="directive-a"> <desc_name classes="sig-name descname" xml:space="preserve"> .. a:: <desc_content> .

SPHINX4-SKIP rst:directive:option (sphinx.domains.rst.ReSTDirectiveOption): .

. <desc_signature classes="sig sig-object" ids="directive-option-a"> <desc_name classes="sig-name descname" xml:space="preserve"> :a: <desc_content> .