Title¶
Bullet lists¶
- This is item 1
- This is item 2
Note that a blank line is required before the first item and after the last, but is optional between items.
Numbered lists¶
- first item
- second item
- third item
Simple table¶
A | B | C |
---|---|---|
False | False | True |
True | False | True |
False | True | True |
True | True | True |
CSV Table¶
Treat | Quantity | Description |
---|---|---|
Albatross | 2.99 | On a stick! |
Crunchy Frog | 1.49 | If we took the bones out, it wouldn’t be crunchy, now would it? |
Gannet Ripple | 1.99 | On a stick! |
Links¶
Go to Vena Website with that link.
Notes and Warnings and Seealso¶
Note
This is a note.
Warning
This is a warning! You can also use: attention, caution, danger, error, hint, important, note, and tip.
See also
- More info here
- Documentation for inline markups.
Misc¶
To provide a link to a download:
If you want some specs then downloadvs91mechanicalspecs.pdf
, but make sure to put the file in the download directory.
To mark a filename in dark type:
When talking aboutsomefile.txt
it should use this markup.
To link to a Python module do this: vcssremote
To provide a link within a document use:
Take a look at Notes and Warnings and Seealso too.
To put a link to another document in the project the do this: Look at /environmental/appendix/bubbletankleak
Table of contents Trees¶
To link to other files (.rst) create a table of contents tree (don’t need to put the .rst in the file name)
Footnotes¶
If you need to refer to a footnote, make sure that you [1] otherwise it will appear in the middle of the paragraph [2].
[1] | place the footnote at the bottom of the document. |
[2] | and that would look wierd. |
Descriptions¶
It is possible to descibe items like this:
-
thwart
A thwart is a strut placed crosswise (left/right) in a ship or boat, to brace it crosswise. In rowboats it can also serve as a seat for a rower.
or like this:
- Gudgeon
- A gudgeon is a circular fitting, often made of metal, which is affixed to a surface. It allows for the pivoting of another fixture. It is generally used with a pintle, which is a pin which pivots in the hole in the gudgeon. As such, a gudgeon is a simple bearing.
- Pintle
- A pintle is a pin or bolt, usually inserted into a gudgeon, which is used as part of a pivot or hinge.