Show Menu
Cheatography
  1. Home >
  2. Cheat Sheets >

Sphinx Cheat Sheet (DRAFT) by

This is a draft cheat sheet. It is a work in progress and is not finished yet.

Headings

##################
H1: document title
##################
 
*********
Sample H2
*********
 
**********
Another H2
**********
 
Sample H3
=========
 
Sample H4
---------
 
Sample H5
^^^^^^^^^
 
Sample H6
"""""""""

Code Blocks

.. highli­ght:: console
make all :: highlights as console (unfor­matted) layout
 
::
    mycode
code formatted as above setting
 
.. code ::
    mycode
same as above
 
.. code :: console
    mycode
same as above except stating the syntax highli­ghting as console

Code highli­ghting types

console
no formatting
python
bash

Inline Highlights

.. ToDo::
Todo item
 
.. Note::
Note