0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXKK00KKKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXKKKKKKXXKKKXK0000KKKKKKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXKKKK0OOOOOOkOKKKOOKXKKKKKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXKKKKK00Okxdolccccll::lxOkkKK0OkkO00KKXXKKXXXXXXXXXXXXXXXXXXXXXXXXXX
0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXKKK00OOkdl:;,..........',,;;:lolclodxxxO0KKKXXKXXXXXXXXXXXXXXXXXXXXXXX
0XXXXXXXXXXXXXXXXXXXXXXXKKKKK00OOkdl:;'......................,,:ldkxdxO0KKXXKKKXKXXXXXXXXXXXXXXXXXXX
0XXXXXXXXXXXXXXXXXXKKKKKK000Oxdol;'..............................,:c:okxxk0KKKKKKKXXXXXXXXXXXXXXXXXX
0XXXXXXXXXXXXXXXXXK0000OOkdoc;,.....................................',:ooox00000KKKKXXXXXXXXXXXXXXXX
0XXXXXXXXXXXXXKKKKOkxolc:;'...........................................,;,cddxkkO00KXKKKXXXXXXXXXXXXX
0XXXXXXXXXXXXXKKKOxol:;;'................................................;olldxkOO0KKKKXXXXXXXXXXXXX
0XXXXXXXXXXKKKKK0Oxxkdl;'............................'''',,,,'''.........,:::ldOOO0KKXXXXXXXXXXXXXXX
0XKKXXXXXXKKK000kdxxl:,'......................'',::ccllloodddoolc;,........,;cddxk00KKKKXXXXXXXXXXXX
0XKKXXXKKKKKKK0kddoll;...................',;::cldxxkkOOOOO0OOOkxdol:,.......':cldxkkOKKKXXXXXXXXXXXX
0XKKKXXKKKKKKKOxdllo;..................';cloddxxkO0000KKKKK0000Okxxl:;'......;::oxxxxOKXXXXXXXXXXXXX
0KKKKKKKKKKKKKKklod:.................,;:oxkO00OOO00000KKKK0K000Okkxdol:,.......;dkOOkk0KXXXXXXXXXXXX
0KKKKKKKKKKKKK0kol;............',,;::lok0KKKKKKK00KKKKKKK0000000Okkxdol:'......;dxOK0kk0KKXXXXXXXXXX
OKKKKKKKKKKKKK0Oo:;...........;odxxkxk0KKXKKKKKK0OO0KKKKK0000000Okkxdolc,......':ldk0Ox0XKKKXXXXXXXX
OKKKKKKKKKKKKKKOo;'..........':dkkOO0KKKXXXXKKKKKKKKKK00KKK0000OOkkxddoc,......',cloO0k0XKKKXXXXXXXX
0KKKKKKKKKKKK0Okd:..........;cldkOOO0KKKXXXXKKK000KKKKKKKXKKKK0Okxxxddol;'.....';lxOO0O0KKKKXXXXXXXX
0KKKKKKKKKKKK00Oo,.........'cddxkOOO0KKKKXXXXXKKKKXXXXXXXXXKKK0Okkxxddooc'......,cdkO00KKKKKKKXXXXXX
OKKKKKKKKKKKKKKOl'.........:odxkkOOO0KKKKKKKKKKXKXXXKKKKK00Okkkxxxddooool,.......cdxOKKKKKKKKKXXXXXX
OKKKKKKKKKKKKK00x;........,ldddlc:ccllloooodxkOOO00OOkkxdoc:;,,,,,;;,,;cl;.......;dO0KKKKKKKKXXXXXXX
OKKKKKKKKKKKKK00Oc........,::c:,,;;,,''''''',:coxxxxxdoc;;,'..'',;;:;,,,;,........lO0KKKKKKKKKKKKXXX
OKKKKKKKKKKKKK00k:...........';;;;;;;;,''''...'',;:::;,'''..''',,,,;,,,;,.........;ok00KKKKKKKKKKXXX
OKKKKKKKKKKKKK00x;........'.':;,'.',,'..':;,,;:;...''..,:;'','...';,''';:;'........,oO0KKKKKKKKKKKKX
OKKKKKKKKKKKKK00x;........:,;ooc;,;cc;,;cooccldc'lkOkl';lc;:ll:;;:c:;;:cll,....'....,cxO000KKKKKKKKX
OKKKKKKKKKKKKKK0Oc.......'l:;dxdocclllllllllloo:l0KK0kc,clcccccccccccclodl,.,,.',',,'':dkO0KKKKKKKKK
OKKKKKKKKKKKKKKK0kl,.....,ll;okkxooddddoodxxxxccOK00Okd:;oxxxdddddddoodxdc,,;::'..'cdxk00KKKKKKKKKKK
OKKKKKKKKKKKKKKKK00xc;,'.'coollooodxkkkkkkxdo::xO0K00kxdc;coxxxxxxxxdoolcccc;:lc'.;dO0KKKKKKKKKKKKKX
OKKKKKKKKKKKKKKKKK0kol:;;;:odxxddooooooooolc;cdkO0000Oxddlc:ccllloooooooodolc;co::d0KKKKKKKKKKKKKKXX
OKKKKKKKKKKKKKKKKK0Oxdoclc:ldxxxkkkOOOOOOkkxxxxkO0KK0OkxdddxkkkkkkkkxxxddoollcldodOKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKOkdodl:codxxxkO00KKKK0OkxdoldOOOkxlccoodkOO000OkxxddooooooodxO0KKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKK0kxxdoooddxxkkO00KK00Okxl;;clllcc;,,cldxO000OOkxddoooodxddk0KKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKKKKOkxolodddxxkkO00000OOkdoloolcclollloxkO00OOkxxdddoodxxkOKKKKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKKKKK00kloddxxxkkkO000OOkkxxdxxddddxdddxxkkOOOkxxdddddox0KKKKKKKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKKKKKKK0kdddxxxkkkkOOkxxxxxkkxkkkkkkxxxxddddxkxxdddddddOKKKKKKKKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKKKKKKKK0xoddxxxxxxxxdlllloooollloollllllcccodddddddddk0KKKKKKKKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKKKKKKK0Odlooddxxxxxdolcc::clooolcllcc:;;;:cloooooddox0KKKKKKKKKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKKKKKKK00Odooooodddxxxxdollloxxxxxxxdolccldddoooooood0KKKKKKKKKKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKKKKKKK00xloollloooodxxxdolc::::;;::::clloddoolllllokKKKKKKKKKKKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKKKKKKK00koodolccllllodddddoollccccclllooooollllllodOKKKKKKKKKKKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKKKKKKKK00kddddlccccllodxxkkkkkxxxxxxxdxddoollclloddk0KKKKKKKKKKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKKKKK00K0Odoxxddolccccoodxkxxxxxxxxdddxxxdolccclodddx0KKKKKKKKKKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKKKK000Odl:''lxxxddollc::cclooooooollllloolccccllooodl;;d0KKKKKKKKKKKKKKKKKKKKKKKKK
OKKKKKKKKKKKKKKKKKK000xl,.....cxxxxxdoolc:;;,,,,,,,,,,,,;;;;;:clloooool,..cOK0KKKKKKKKKKKKKKKKKKKKKK
OK0KKKKKKKKKKK000000xc........lxxxxxxddollc:;,''......'',;::clloooooooo,...cOK00000KKKKKKKKKKKKKKKKK
O000KKKKKKK0000000Oo'........,oxxxxxxxxddooolcc:;;,,,;;:clllloooooooooo;....l00000000000KKKKKKKKKKKK
O0000KKKK00000000kc..........:dxxxxxxxxxxddddddddooooooooooooooooooddoo:....'ck000000000KK0KKKKKKKKK
O000000000000Oxoc;'.........,odxxkkkkxxxxxxxxkkkkkkkkkxxdoooooooooodoooc'.....,:loxO00000000KKKKKKK0
k0000000000kl;..............cddxxkkkkkxxdddxxkOOOOOOOOkxdooooodddddooooc,..........;lx00000000000000

                    

Frank Martin

Biomedical Engineer & Software Engineer

About me

Very interesting story I am sure.. Let's test some styles.


1   What is reStructuredText?

An easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system, abbreviated rst. In other words, using a simple text editor, documents can be created which

  • are easy to read in text editor and
  • can be automatically converted to
    • html and
    • latex (and therefore pdf)

2   What is it good for?

reStructuredText can be used, for example, to

  • write technical documentation (so that it can easily be offered as a pdf file or a web page)
  • create html webpages without knowing html
  • to document source code

3   Show me some formatting examples

You can highlight text in italics or, to provide even more emphasis in bold. Often, when describing computer code, we like to use a fixed space font to quote code snippets.

We can also include footnotes [1]. We could include source code files (by specifying their name) which is useful when documenting code. We can also copy source code verbatim (i.e. include it in the rst document) like this

1
2
3
4
5
6
import frank

def look(at: str):
    me = "I am colorized"
    frank.notify()
    return f"Awesome: {at}"

We have already seen at itemised list in section What is it good for?. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well.

4   Where can I learn more?

reStructuredText is described at http://docutils.sourceforge.net/rst.html. We provide some geeky small print in this footnote [2].

Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well.

5   Henk

Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well. Enumerated list and descriptive lists are supported as well. It provides very good support for including html-links in a variety of ways. Any section and subsections defined can be linked to, as well.

6   Show me some more stuff, please

We can also include figures:

The magnetisation in a small ferromagnetic disk. The diametre is of the order of 120 nanometers and the material is Ni20Fe80. Png is a file format that is both acceptable for html pages as well as for (pdf)latex.


[1]although there isn't much point of using a footnote here.
[2]

Random facts:

  • Emacs provides an rst mode
  • when converting rst to html, a style sheet can be provided (there is a similar feature for latex)
  • rst can also be converted into XML
  • the recommended file extension for rst is .txt