11. Appendices

To use this template, simply update it:

import read-the-docs-template

11.1. Usage

  • Be awesome
  • Make things faster

No matter where you go, there you are.

—Buckaroo Banzai

( (title_, subtitle_?)?,
  decoration_?,
  (docinfo_, transition_?)?,
  `%structure.model;`_ )

def my_function():
    "just a test"
    print 8/2
Just as a solid …
With these highlights …
There is also a general …

11.1.1. Sphinx cheat sheet

Here is a quick and dirty cheat sheet for some common stuff you want to do in sphinx and ReST. You can see the literal source for this file at cheatsheet-literal.

11.1.1.1. Formatting text

You use inline markup to make text italics, bold, or monotype.

Tip

This is the documentation for the stable 3.0 branch. Looking for the documentation of the current development branch? Have a look here. For the stable 2.1 branch, it’s here.

Note

Godot Engine is an open source project developed by a community of volunteers. It means that the documentation team can always use your feedback and help to improve the tutorials and class reference. If you do not manage to understand something, or cannot find what you are looking for in the docs, help us make the documentation better by letting us know!

Submit an issue or pull request on the GitHub repository, or discuss with us on the #godotengine-doc IRC channel on freenode!

You can represent code blocks fairly easily:

import numpy as np
x = np.random.rand(12)

Or literally include code:

11.1.1.2. Making a list

It is easy to make lists in rest

11.2. Bullet points

This is a subsection making bullet points

  • point A
  • point B
  • point C

created by … surrounding paragraph.

Neither from itself nor from another, Nor from both, Nor without a cause, Does anything whatever, anywhere arise.

—Nagarjuna - Mulamadhyamakakarika

11.3. Enumerated points

This is a subsection making numbered points

  1. point A
  2. point B
  3. point C
These lines are
broken exactly like in
the source file.
is my name
**No** interpretation of
|special| characters.

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

Some text that requires a footnote [1] .

Footnotes

[1]Text of the first footnote.

It is easy to make a link to yahoo or to some section inside this document (see making-a-table) or another document.

You can also reference classes, modules, functions, etc that are documented using the sphinx autodoc facilites. For example, see the module :mod:`matplotlib.backend_bases` documentation, or the class :class:`~matplotlib.backend_bases.LocationEvent`, or the method :meth:`~matplotlib.backend_bases.FigureCanvasBase.mpl_connect`.