NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[IMP] contributing: update the rst cheat sheet

Browse Source 
task - 2810468

closes odoo/documentation#1825

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
This commit is contained in:
Jonathan Castillo (jcs) 2022-04-12 08:46:50 +00:00 committed by Antoine Vandevenne (anv)
parent 0db39e3564
commit 9ff312298d
4 changed files with 662 additions and 537 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
content/contributing/documentation/content_guidelines.rst
View File

@ -149,7 +149,7 @@ are not only displayed in the document but also on the navigation menu (only the
.. seealso::
- :ref:`RST cheat sheet: headings <contributing/headings>`
- :ref:`RST cheat sheet: specialized directives <contributing/specialized-directives>`
- :ref:`RST cheat sheet: markups <contributing/markups>`
.. _contributing/organizing-documentation:

1146
content/contributing/documentation/rst_cheat_sheet.rst
View File

File diff suppressed because it is too large Load Diff

31
content/contributing/documentation/rst_guidelines.rst
View File

@ -58,18 +58,18 @@ an additional whitespace in HTML. That means that you do not need to leave a tra
the end of a line to separate words.
.. tip::
You can safely break a line around the separators (``-->``) of ``menuselection`` directives and
anywhere in a hyperlink reference. For the ``doc``, ``ref`` and ``download`` directives, this is
You can safely break a line around the separators (``-->``) of ``menuselection`` markups and
anywhere in a hyperlink reference. For the ``doc``, ``ref`` and ``download`` markups, this is
only true for the label part of the reference.
Example: Line breaks within directive and inline markup
-------------------------------------------------------
Example: Line breaks within markups
-----------------------------------
.. code-block:: rst
To register your seller account in Odoo, navigate to :menuselection:`Sales --> Configuration
--> Settings --> Amazon Connector --> Amazon Accounts` and click on **CREATE**. The **Seller
ID** can be found under the link **Your Merchant Token**.
To register your seller account in Odoo, go to :menuselection:`Sales --> Configuration --> Settings
--> Amazon Connector --> Amazon Accounts` and click on :guilabel:`CREATE`. You can find the **Seller
ID** under the link :guilabel:`Your Merchant Token`.
Be consistent with indentation
==============================
@ -77,7 +77,7 @@ Be consistent with indentation
Use only spaces (never tabs).
Use as many spaces at the beginning of an indented line as needed to align it with the first
character of the directive in the line above. This usually implies 3 spaces but you only need 2 for
character of the markup in the line above. This usually implies 3 spaces but you only need 2 for
bulleted lists.
Example: The first ``:`` is below the ``i`` (3 spaces)
@ -110,15 +110,14 @@ Example: Continuation lines resume below the ``I``’s of “Invoice” (2 space
.. _contributing/menuselection:
Use the menuselection directive
===============================
Use the menuselection markup
============================
Although chaining characters ``‣`` and menu names works fine to indicate a user which menus to
click, it is best to use the ``menuselection`` directive (see
:ref:`contributing/specialized-directives`) for the same result. Indeed, it renders the menus chain
consistently with the rest of the documentation and would automatically adapt to the new graphic
chart if we were to switch to a new one. This directive is used inline as follows:
``:menuselection:`Settings --> Products --> Variants```.
click, it is best to use the ``menuselection`` markup (see :ref:`contributing/menuselection`) for
the same result. Indeed, it renders the menus chain consistently with the rest of the documentation
and would automatically adapt to the new graphic chart if we were to switch to a new one. This
markup is used inline as follows: ``:menuselection:`Sales --> Settings --> Products --> Variants```.
.. _contributing/resilient-code:
@ -138,7 +137,7 @@ Prefix hyperlink targets with application names
===============================================
As hyperlink targets are visible from the entire documentation when referenced with the ``ref``
directive, it is recommended to prefix the target name with that of the related application. For
markup, it is recommended to prefix the target name with that of the related application. For
instance, naming a target ``_amazon/form`` instead of ``_form`` avoids unwanted behaviors and makes
the purpose of the target clear.

20
static/css/showcase_tables.css Normal file
View File

@ -0,0 +1,20 @@
#wrap main table.o-showcase-table > tbody > tr.row-even .highlight-text {
border: none;
margin: 0;
}
table.o-showcase-table > tbody > tr.row-odd > td {
border: 1px solid #d5d5d5;
padding: 2rem;
}
table.o-showcase-table > tbody > tr.row-odd > td .highlight-text {
margin: 0;
}
table.o-showcase-table > tbody > tr.row-even > td {
display: grid;
padding: 1rem;
background: #f8f8f8;
border: 0;
}