by

Rst Cheat Sheet



  1. Rst Cheat Sheet Printable
  2. Restructuredtext Video
  3. Rst Cheat Sheet 2020
  4. Rst Cheat Sheet Fantasy Football
  5. Rst Cheat Sheet
  6. Rst Cheat Sheets

Equivalent to emphasis. Equivalent to literal but processes backslash escapes. Reference to a numbered Python Enhancement Proposal. Reference to a numbered Internet Request For Comments.

Headings

For each formatting line (e.g., ), write as many symbols (=) as there are characters inthe header.
The symbols used for the formatting are, in fact, not important. Only the order in which they arewritten matters, as it determines the size of the decorated heading. This means that you mayencounter different heading formatting and in a different order, in which case you should followthe formatting in place in the document. In any other case, use the formatting shown below.

You can include links to other locations in the same document, to locations in other documents and to external websites. For more information about creating links using reStructured Text and Sphinx, see Sphinx Hyperlinks. Fantasy Championship. The Fantasy Championship (TFC) is the multi-league online fantasy football championship with a $300,000 GRAND PRIZE plus league prizes. Don't miss your chance to win big in fantasy football, draft today! Rust Language Cheat Sheet Rust Language Cheat Sheet This site was tested on animals and got 4.5 stars. Contains clickable links to The Book BK, Rust by Example EX, Std Docs STD, Nomicon NOM, Reference REF. Other symbols used: largely deprecated 🗑️, has a minimum edition '18, is work in progress 🚧. ReStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents.

Heading sizeFormattingMin/Max number of occurrences
H1
Heading
1/1
H20/∞
H3
-------
0/∞
H4
~~~~~~~
0/∞
H5
*******
0/∞
H6
^^^^^^^
0/∞

Markup

Inline markup

Use the following markups to emphasize your text to your liking:

**Text**Text
*Text*Text
``Text``Text

Дивись також

Bulleted list

Numbered list

Nested lists

Hyperlinks

Hyperlink references

Hyperlink references are links to a URL with a custom label. They follow this syntax:`label <URL>`_

Примітка

The URL can be a relative path to a file within the documentation.

Приклад

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 hyperlinkreference.”

External hyperlink targets

External hyperlink targets allow creating shortcuts for hyperlink references.
The definition syntax is as follows: .. _target: URL
There are two ways to reference them, depending on the use case:
  1. target_ creates a hyperlink with the target name as label and the URL as reference. Note thatthe _ moved after the target!
  2. `label <target_>`_ does exactly what you expect: the label replaces the name of the target,and the target is replaced by the URL.

Приклад

RST
Перегляд

A proof-of-concept is a simplified version, aprototype of what is expected to agree on the main lines of expected changes. PoC is a common abbreviation.

Internal hyperlink targets

Internal hyperlink targets follow the same syntax as external hyperlink targets but without any URL.Indeed, they are internal. They allow referencing a specific part of a document by using the targetas an anchor. When the user clicks on the reference, the documentation scrolls to the part of thepage containing the target.

Важливо

Targets can be referenced from other files than the ones in which they are defined.

There are two ways to reference them, both using the ref directive:
  1. :ref:`target` creates a hyperlink to the anchor with the heading defined below as label.
  2. :ref:`label <target>` creates a hyperlink to the anchor with the given label.

See Use relative links for internal URLs to learn how to write proper relative links for internalreferences.

Rst Cheat Sheet Printable

Примітка

Notice that there is no _ at the end, as it is done with hyperlink targets.

Приклад

RST
Перегляд

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, …

Implicit hyperlink targets

Implicit hyperlink targets are a special kind of internal hyperlink targets: they areautomatically generated by section titles, footnotes, etc. Consequently, they don’t have adefinition syntax.
They can be referenced the same first way as external hyperlink targets by using the name of thesection title as URL.

Приклад

RST
Перегляд

This can easily be done by creating a new user, see How to create a new user? for additional help. …

The doc directive

The doc directive allows referencing a documentation page wherever it is in the file treethrough a relative file path.
Rst
As usual, there are two ways to use the directive:
  1. :doc:`path_to_doc_page` creates a hyperlink reference to the documentation page with thetitle of the page as label.
  2. :doc:`label <path_to_doc_page>` creates a hyperlink reference to the documentation page withthe given label.

Приклад

RST
Перегляд

Please refer to this documentation and toSend a pro-forma invoice.

The download directive

The download directive allows referencing files (that are not necessarily RST documents) within the source tree to be downloaded.

Приклад

RST
Перегляд

Download this module structure template tostart building your module in no time.

The image directive

Restructuredtext Video

The image directive allows inserting images in a document. It comes with a set of optionalparameter directives that can individually be omitted if considered redundant.

Приклад

RST
Перегляд

Admonitions (alert blocks)

Seealso

RST

Перегляд

Дивись також

Примітка

RST

Перегляд

Примітка

Use this to get the attention of the reader about additional information.

Чайові

RST

Rst

Перегляд

Порада

Use this to inform the reader about a useful trick that requires anaction.

Важливий

RST

Перегляд

Важливо

Use this to notify the reader about an important information.

Попередження

RST

Перегляд

Rst Cheat Sheet

Попередження

Use this to require the reader to proceed with caution with what isdescribed in the warning.

Небезпека

RST

Перегляд

Небезпека

Use this to alarm the reader about a serious threat.

Printable

Formatting tips

Add banners on top of documents

Odoo feature

The Odoo theme supports banner images at the top of documents. At the first line of your documents,insert the directive :banner: banners/file_name.png. Replace file_name.png with the filethat you placed in _static/banners to server as a banner of your document.

Break the line but not the paragraph

RST

Перегляд

Rst Cheat Sheet 2020

First super long line that you break in two…here is rendered as a single line.

Add comments

Rst

If you made a particular choice of writing or formatting that a future writer should be able tounderstand and take into account, consider writing a comment. Comments are blocks of text that donot count as a part of the documentation and that are used to pass a message to writers of thesource 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.

Use tables

Make use of this convenient table generator tobuild your tables. Then, copy-paste the generated formatting into your document.

Spice up your writing with specialized directives

Use these additional directives to fine-tune your content:

DirectivePurposeПриклад
RSTHTML
abbrSelf-defining abbreviations:abbr:`SO (Sales Order)`SO
commandHighlight a command:command:`python example.py`python example.py
dfnDefine a term:dfn:`a definition for a new term`a definition for a new term
fileIndicate a file path:file:`~/odoo/odoo-bin`~/odoo/odoo-bin
menuselectionGuide a user through a sequence of menus:menuselection:`Sales --> Configuration --> Settings`Sales ‣ Configuration ‣ Settings

Escape markup symbols (Advanced)

Markup symbols escaped with backslashes () are rendered normally. For instance, this**line of text** with *markup* symbols is rendered as “this **line of text** with*markup* symbols”.

When it comes to backticks (`), which are used in many case such as hyperlink references, using backslashes for escaping is no longer an option becausethe outer backticks interpret enclosed backslashes and thus prevent them from escaping innerbackticks. For instance, ``this formatting`` produces an [UNKNOWN NODE title_reference]error. Instead, ```this formatting``` should be used to produce the following result:`this formatting`.

Welcome to the Introduction to Sphinx & Read the Docs.This tutorial will walk you through the initial stepswriting reStructuredText and Sphinx,and deploying that code to Read the Docs.

Please provide feedback to @ericholscher.

Schedule¶

  • 9-9:30 Introduction to the Tutorial
  • 9:30-9:50 Getting Started: Overview & Installing Initial Project
  • 9:50-10:20 Step 1: Getting started with RST
  • 10:20-10:40 Break
  • 10:40-11:10 Step 2: Building References & API docs
  • 11:10-11:40 Step 3: Keeping Documentation Up to Date
  • 11:40-12:20 Finishing Up: Additional Extensions & Individual Exploration

Thanks for coming

Tutorial

  • Getting Started: Overview & Installing Initial Project
  • Step 1: Getting started with RST
  • Step 2: Building References & API docs
  • Step 3: Keeping Documentation Up to Date
  • Finishing Up: Additional Extensions & Individual Exploration

Supplemental Material

Rst Cheat Sheet Fantasy Football

  • Cheat Sheet

Step 1

  • Crawler Step 1 Documentation

Step 2

  • Crawler Step 2 Documentation
    • Cookbook
    • Crawler Python API

Rst Cheat Sheet

Step 3

Rst Cheat Sheets

  • Crawler Step 3 Documentation
    • Cookbook
    • Crawler Python API