Skip to content

Latest commit

 

History

History
839 lines (761 loc) · 15.1 KB

docutil_syntax_elements.md

File metadata and controls

839 lines (761 loc) · 15.1 KB
Raw

Raw . foo . foo .

Hard-break . foo
bar . foo
\ bar .

Strong: . foo . foo .

Emphasis . foo . foo .

Escaped Emphasis: . *foo* . foo .

Mixed Inline . a b c abc \* . a b

    <strong>
        c

    <literal>
        abc
     \*

.

Inline Code: . foo . foo .

Heading: .

foo

.

<title> foo .

Heading Levels: .

a

b

c

d

.

<title> a
<title> b
<title> c
<title> d .

Block Code: . foo . <literal_block classes="code" xml:space="preserve"> foo .

Fenced Code: .

foo

. <literal_block classes="code sh" xml:space="preserve"> foo .

Fenced Code no language: .

foo

. <literal_block classes="code" xml:space="preserve"> foo .

Fenced Code no language with trailing whitespace: .

foo

. <literal_block classes="code" xml:space="preserve"> foo .

Image empty: . . .

Image with alt and title: . alt . alt .

Image with escapable html: . alt . alt .

Block Quote: .

foo .

foo .

Bullet List: .

  • foo
  • bar .
foo bar .

Nested Bullets .

  • a
    • b
      • c
    • d .
a b c d .

Enumerated List: .

  1. foo
  1. bar

para

  1. starting
  2. enumerator .
foo bar para starting enumerator .

Nested Enumrated List: .

  1. a
  2. b
    1. c .
a b c .

Sphinx Role containing backtick: . {code}a=1{`} . a=1{`} .

Target: . (target)= . .

Target with whitespace: . (target with space)= . .

Referencing: . (target)=

Title

alt1

alt2

alt3 .

<title> Title alt1 alt2 alt3 .

Comments: . line 1 % a comment line 2 . line 1 a comment line 2 .

Block Break: . +++ string . string .

Link Reference: . name

. name .

Link Reference short version: . name

. name .

Block Quotes: .

a b*c*

-- a**b**

. <block_quote classes="epigraph"> a b c a b .

Link Definition in directive: .

[a]

. a .

Link Definition in nested directives: .

[ref1]: link

[ref1]
[ref2]

[ref2]: link

. ref1

        [ref2]
<note>

.

Footnotes: . 1

footnote text .

Footnotes nested blocks: . 1

finish . <footnote_reference auto="1" ids="id1" refname="a"> finish footnote text abc

        xyz
    <block_quote>
        <paragraph>
            a
    <bullet_list bullet="-">
        <list_item>
            <paragraph>
                b
    <paragraph>
        c

.

Front Matter: .

a: 1 b: foo c: d: 2

. <field_list> <field_name> a <field_body> 1 <field_name> b <field_body> foo <field_name> c <field_body> {"d": 2} .

Front Matter Biblio: .

author: Chris Sewell authors: Chris Sewell, Chris Hodgraf organization: EPFL address: | 1 Cedar Park Close Thundersley Essex contact: https://example.com version: 1.0 revision: 1.1 status: good date: 2/12/1985 copyright: MIT dedication: | To my homies abstract: Something something dark side other: Something else

. <field_list> <field_name> author <field_body> Chris Sewell <field_name> authors <field_body> Chris Sewell, Chris Hodgraf <field_name> organization <field_body> EPFL <field_name> address <field_body> 1 Cedar Park Close

                Thundersley
                
                Essex
                
    <field>
        <field_name>
            contact
        <field_body>
            <paragraph>
                <reference refuri="https://example.com">
                    https://example.com
    <field>
        <field_name>
            version
        <field_body>
            <paragraph>
                1.0
    <field>
        <field_name>
            revision
        <field_body>
            <paragraph>
                1.1
    <field>
        <field_name>
            status
        <field_body>
            <paragraph>
                good
    <field>
        <field_name>
            date
        <field_body>
            <paragraph>
                2/12/1985
    <field>
        <field_name>
            copyright
        <field_body>
            <paragraph>
                MIT
    <field>
        <field_name>
            dedication
        <field_body>
            <paragraph>
                To my 
                <emphasis>
                    homies
                
    <field>
        <field_name>
            abstract
        <field_body>
            <paragraph>
                Something something 
                <strong>
                    dark
                 side
    <field>
        <field_name>
            other
        <field_body>
            <paragraph>
                <literal>
                    Something else

.

Front Matter Bad Yaml: .

a: {

. <system_message level="3" line="1" source="notset" type="ERROR"> Front matter block: while parsing a flow node expected the node content, but found '' in "", line 1, column 5: a: { ^ <literal_block xml:space="preserve"> a: { .

Front Matter HTML Meta .

html_meta: keywords: Sphinx, documentation, builder description lang=en: An amusing story description lang=fr: Un histoire amusant http-equiv=Content-Type: text/html; charset=ISO-8859-1

. .. internal attributes: .transform: docutils.transforms.components.Filter .details: component: 'writer' format: 'html' nodes: .. internal attributes: .transform: docutils.transforms.components.Filter .details: component: 'writer' format: 'html' nodes: .. internal attributes: .transform: docutils.transforms.components.Filter .details: component: 'writer' format: 'html' nodes: .. internal attributes: .transform: docutils.transforms.components.Filter .details: component: 'writer' format: 'html' nodes: .

Full Test: .

a: 1

(target)=

header 1

sub header 1

a b c abc

sub header 2

x y a z

header 2

a = 1

. <field_list> <field_name> a <field_body> 1

<title> header 1
<title> sub header 1 a b

            <strong>
                c
             
            <literal>
                abc
    <section ids="sub-header-2" names="sub\ header\ 2">
        <title>
            sub header 2
        <paragraph>
            x y 
            <reference refuri="http://www.xyz.com">
                a
             z
        <transition>
<section ids="header-2" names="header\ 2">
    <title>
        header 2
    <literal_block classes="code ::python" xml:space="preserve">
        a = 1
    <paragraph>
        <reference refname="target">

.

Footnotes

  1. footnotetext . ↩ ↩2