===), write as many symbols (
=) as there are characters in the header.
|Heading size||Formatting||Min/Max number of occurrences|
Use the following markups to emphasize your text to your liking:
- This is a bulleted list. - It has two items, the second item uses two lines.
* This is a bulleted list too. * The principle stays the same.
#. This is a numbered list. #. Numbering is automatic.
1. This is a numbered list too. 2. Use this format to specify the numbering.
- This is the first item of a bulleted list. 1. It has a nested numbered list 2. with two items.
This excerpt of RST:
For instance, `this is a hyperlink reference
<https://odoo.com>`_. is rendered as follows in HTML: “For instance, this is a hyperlink
.. _proof-of-concept: https://en.wikipedia.org/wiki/Proof_of_concept A proof-of-concept_ is a simplified version, a prototype of what is expected to agree on the main lines of expected changes. `PoC <proof-of-concept_>`_ is a common abbreviation.
.. _sales/quotation/start-of-page: This can easily be done by creating a new product, see :ref:`product` for additional help. .. _sales/quotation/product: How to create a product? ========================= As explained at the :ref:`start of the page <sales/quotation/start-of-page>`, ...
This can easily be done by creating a new product, see How to create a product? for additional help.
How to create a product?
As explained at the start of the page, ...
This can easily be done by creating a new user, see `How to create a new user?`_ for additional help. ...
This can easily be done by creating a new user, see How to create a new user? for additional help. ...
docdirective allows referencing a documentation page wherever it is in the file tree through a relative file path.
:doc:`path_to_doc_page`creates a hyperlink reference to the documentation page with the title of the page as label.
:doc:`label <path_to_doc_page>`creates a hyperlink reference to the documentation page with the given label.
Please refer to :doc:`this documentation <customer_invoices>` and to :doc:`../sales/invoicing/proforma`.
download directive allows referencing files (that are not necessarily RST documents) within the source tree to be downloaded.
Download this :download:`module structure template <extras/my_module.zip>` to start building your module in no time.
Download this module structure template to start building your module in no time.
image directive allows inserting images in a document. It comes with a set of optional
parameter directives that can individually be omitted if considered redundant.
.. image:: media/create_invoice.png :align: center :alt: Create an invoice :height: 100 :width: 200 :scale: 50 :class: img-thumbnail :target: ../invoicing.html#create-an-invoice
Admonitions (alert blocks)
.. seealso:: - :doc:`customer_invoices` - `Pro-forma invoices <../sales/invoicing/proforma.html#activate-the-feature>`_
.. note:: Use this to get the attention of the reader about additional information.
Use this to get the attention of the reader about additional information.
.. tip:: Use this to inform the reader about a useful trick that requires an action.
Use this to inform the reader about a useful trick that requires an action.
.. important:: Use this to notify the reader about an important information.
Use this to notify the reader about an important information.
.. warning:: Use this to require the reader to proceed with caution with what is described in the warning.
Use this to require the reader to proceed with caution with what is described in the warning.
.. danger:: Use this to alarm the reader about a serious threat.
Use this to alarm the reader about a serious threat.
Break the line but not the paragraph
| First super long line that you break in two… here is rendered as a single line. | Second line that follows a line break.
If you made a particular choice of writing or formatting that a future writer should be able to understand and take into account, consider writing a comment. Comments are blocks of text that do not count as a part of the documentation and that are used to pass a message to writers of the source code. They consist of a line starting with two dots and a space, followed by the comment.
.. For instance, this line will not be rendered in the documentation.
Make use of this convenient table generator to build your tables. Then, copy-paste the generated formatting into your document.
Spice your writing with specialized directives
Use these additional directives to fine-tune your content:
|Highlight a command||python example.py|
|Define a term||a definition for a new term|
|Indicate a file path|
|Guide a user through a sequence of menus|
Escape markup symbols (Advanced)
Markup symbols escaped with backslashes (
\) are rendered normally. For instance,
\*\*line of text\*\* with \*markup\* symbols is rendered as “this **line of text** with
When it comes to backticks (
`), which are used in many case such as hyperlink references, using backslashes for escaping is no longer an option because
the outer backticks interpret enclosed backslashes and thus prevent them from escaping inner
backticks. For instance,
`\`this formatting\`` produces an
[UNKNOWN NODE title_reference]
```this formatting``` should be used to produce the following result: