Sphinx Cheat Sheet

Posted : admin On 1/2/2022
Sphinx Cheat Sheet

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:

Class AClass: ' Class docstring, with reference to the:mod:`module`, or another class:class:`module.AnotherClass` and its function:func:`module.AnotherClass.foo`. ' class AnotherClass: ' Another class' docstring. ' def foo (arg1, arg2): ' A method's docstring with parameters and return value. Use all the cool Sphinx capabilities in this description, e.g. To give usage examples. ReStructuredText Cheatsheet. The GMT documentations are written in reStructureText (ReST) and built by Sphinx. Here is a quick and dirty cheat sheet for some common ReST stuff used in GMT documentations. You can see the literal source code of the ReST. WxPython Classes Cheat Sheet. A wikipage to help you write scripts which was generated by a script attatched to the wikipage. NB: Think of this page as a collection of shortcuts to the docs. It is not comprehensive in any way. There are many more classes in the wx library than listed here, and most classes have many more methods. 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.

Formatting text¶

Sphinx Cheat Sheet Pdf

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¶

Riddle Of The Sphinx Cheat Sheets Printable

This is a subsection making numbered points

  1. point A
  2. point B
  3. point C

Making a table¶

Sphinx Cheat Sheet

This shows you how to make a table – if you only want to make a list see Making a list.

NameAge
John D Hunter40
Cast of Thousands41
And Still More42

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¶