Menu
- Sphinx Cheat Sheet Pdf
- Riddle Of The Sphinx Cheat Sheets
- Sphinx Cheat Sheet
- Riddle Of The Sphinx Cheat Sheets Printable
To perform the sphinx test, place each index finger in a sacral sulcus and place each thumb on an ILA. Now have the patient extend their lumbar spine by getting up on their.
Here is a quick and dirty cheat sheet for some common stuff you wantto do in sphinx and ReST. You can see the literal source for thissheet here This file. More basic documentation can be found at this resources:
- The Essential Sphinx Markup Cheatsheet for Faster Documentation. Carla Schroder. November 18, 2015. Last week, in Write Documentation Once, Output Multiple Formats with Sphinx we learned how to install the Sphinx documentation generator, and how to build HTML, PDF, Epub, and other documents from a new Sphinx installation.
- The reference is replaced with the section title when Sphinx builds the document while maintaining the linking mechanism. For example, the above reference will appear as Sphinx Cheat Sheet. As the documentation grows there are many references to keep track of. For documents, please use a reference label that matches the file name.
Formatting text¶
You use inline markup to make text italics, bold, or
monotype
.You can represent code blocks fairly easily:
Or literally include code:
Making a list¶
It is easy to make lists in rest
Bullet points¶
This is a subsection making bullet points
- point A
- point B
- point C
Enumerated points¶
This is a subsection making numbered points
- point A
- point B
- point C
Making a table¶
This shows you how to make a table – if you only want to make a list see Making a list.
Name | Age |
---|---|
John D Hunter | 40 |
Cast of Thousands | 41 |
And Still More | 42 |
Making links¶
It is easy to make a link to yahoo or to somesection inside this document (see Making a table) or anotherdocument.
You can also reference classes, modules, functions, etc that aredocumented using the sphinx autodoc facilites. For example,see the module
matplotlib.backend_bases
documentation, or theclass LocationEvent
, or the methodmpl_connect()
.This file¶
Every reST (.rst) file should use these underlining styles. In reST, you can use differentstyles in any order you want. These are our conventions for TYPO3 documentation.
- line 1-3: This is the doc title. Every .rst file should have one.
- line 7: header label. This can be used for cross-referencing to this section:
- 9-10: Header level 1
- etc.
See also
External links¶
method 1:
(with one or two underscores at the end, if in doubt, use two)
method 2: “External Hyperlink Targets”:
This may be more convenient if you use a link several times.
Cross references¶
When linking within docs.typo3.org, you should use this method of cross-referencing.
Use it to link to a section in this manual:
A section with the label intersphinx must exist! It is placed before the header:
Or, when cross-referencing to other manuals:
When you are linking to another manual, make sure theshortcut (here: “h2document”) is included in Settings.cfg:
We use the same conventions for naming the shortcuts in
Settings.cfg
,see Settings.cfg. Not used manuals are commented out.Tip
This is a cool feature, where reST & Sphinx shines: Even when a section ismoved to another page (which effectively changes the URL), the link will still work!
Link to: Same manual | Link to: Other manual | |
---|---|---|
Explicit anchor text | :ref:`CrossReferencing<intersphinx>` | :ref:`CrossReferencing<t3docwrite:intersphinx>` |
Automatic anchor text | :ref:`intersphinx` | :ref:`t3docwrite:intersphinx` |
See also
- Link targets (labels)
To create a bullet list:
- add a blank line before and after the list
- indent the list item text by 3 spaces - including the item sign
- to create a nested list:
- indent the items by 3 spaces (left-align with parent item text)
- apply rules of parent list (blank lines, item text indentation, ..)
More text.
To create a numbered list:
- add a blank line before and after the list
- indent the list item text by 3 spaces - including the item sign
- to create a nested list:
- indent the items by 3 spaces (left-align with parent item text)
- apply rules of parent list (blank lines, item text indentation, ..)
More text.
Important
Use syntactically correct code in your code blocks.
Code block directive¶
How it looks:
Source:
This uses the directive “code-block” (line 1)
Important
Make sure to indent correctly. The lines of the code-block (line 3+)must be indented (3 spaces).
Literal Block (::
)¶
Or, use the literal block markup
::
if PHP is already set as defaultwith highlight
directive and you want to combine a text with a colon,followed by the code block.How it looks:
Assign the variable a:
Source:
For inline code or for other semantic markup of special texts, use text roles.
Examples:
$result=$a+23;
(PHP snippet)lib.hello.value=HelloWorld!
(TypoScript snippets)/etc/passwd
(file)- ctrl + s (keyboard strokes)
Source (inline text with text roles):
Normal text, bold text and italic text.
Source (bold & italic):
Source (image):
Another example:
See also
Source (YouTube):
This is often used, for a Quick Start section, involving a few numbered steps:
With Big Numbers¶
This is an example with a code block (
::
) embedded in the sections.Source:
How it looks:
- Embed an imageSource:
- TwoDo something else …
With Big Numbers XXL¶
Sphinx Cheat Sheet Pdf
Source:
How it looks:
- Embed an imageSource:
- TwoDo something else …
Tips, hints, important (Admonitions)¶
![Sphinx Cheat Sheet Sphinx Cheat Sheet](/uploads/1/1/9/8/119877900/448749817.png)
Tip
Riddle Of The Sphinx Cheat Sheets
To look at the reST source of this rendered page, scroll to the bottomand click on “View page source”.
- Source (tip):
Sphinx Cheat Sheet
Diagrams¶
Riddle Of The Sphinx Cheat Sheets Printable
Source:
How it looks: