Skip to content

Latest commit

 

History

History
297 lines (175 loc) · 3.91 KB

docutils.rst

File metadata and controls

297 lines (175 loc) · 3.91 KB
Raw

document title must be completely underlined and upperlined with =

toc title

1   h1

must have at least as many underline symbols as length

underline symbol can be anything.

overline is optiona

the first time it appears defines the level of a symbol.

if you change that aftewards, you get an error.

convention used on python docs (aka follow it!!):

  • # with overline: parts

  • * : chapters

  • = without : sections. This is what people usually put as h1 level,

    but will become a h3 if you use parts and chapters.

  • - : subsections

  • ^ : subsubsections

  • " : paragraphs

a bit confusing, and hard to compute IMHO:

1.1   h2

1.1.1   h3

1.1.1.1   h4

2   par

par1

par2

3   pre

   this is a *preformatted* section
       indent
indent minus
   must end in blank line!

not anymore. must have blank line above.

another:

this is the **pre**

another

this is the **pre**

*inline pre*

4   link

inline: inline to google

note that the name is kept from now on! inline to google

can also to this

explicit: http://www.google.com [email protected] with no link text: www.google.com

except you do __: one hit, then the following would be undefined: `one hit`_

google

multi word

links to subdir unless if fits into some known protocol such as http or email: tosubdir maillink

4.1   anonymous

text of ano1

text of ano2

text of ano3

4.2   internal

partarget

this par has id "partarget"

partarget1 partarget2

this par has partarget2 and starts with a span partarget1

inline internal target. a link to it: inline internal target. This makes a span with id.

toid

uitarget

  • this ui has id "uitarget"

to headers makes a span before the header:

htarget

5   doctest

same as pre.

no check is actually done.

>>> print 'a'
a
>>> print 'a'
b

6   blockquote

par

same as pre.

no check is actually done.

blockquote line 2

another:

blockquote line 2

—author

7   dl

term 1
Definition 1.
term 2

Definition 2, paragraph 1.

Definition 2, paragraph 2.

term 3 : classifier
Definition 3.
term 4 : classifier one : classifier two
Definition 4.

8   comment

9   field list

key:value
key2:value 2

10   directive

Note

note content

Topic Title

stuff inside the topic

before

sidebar

Sidebar Title

Optional Sidebar Subtitle

body of sidebar

after

sidebar

def my_function():
    "just a test"
    print 8/2
\alpha _t(i) = P(O_1, O_2, \ldots  O_t, q_t = S_i \lambda )

replaced: reStructuredText

unicode: © BogusMegaCorp™—

datetime: 2025-01-07 12:15

10.1   include

10.2   raw

is only used for respective output.

html only shows in html output:

raw html

latex only shows in latex output:

11   roles

can go before or after `

a^b_c a^b_c

a^b_c

\pi^e