How do we embed images in sphinx docs?

.. image:: example.png
    :width: 480pt

The path to the image is relative to the file.

Document your Django projects: reStructuredText and Sphinx

Generating Code Documentation With Pycco

$ pip install pycco
$ cd to/root/of/project
$ pycco **/*.py   -p -i

First steps with Sphinx

$ pip install Sphinx
$ sphinx-quickstart

Build docs

$ sphinx-build -b html . build

bitbucket ReadMe Markdown

Bitbucket Supported Markdown for READMEs, comments, and Wiki


# with overline, for parts

  • with overline, for chapters

= for sections

  • for subsections

^ for subsubsections

“ for paragraphs