by

Ciro Santilli (@cirosantilli, 34)

Sphinx (documentation generator)

Table of contents

@cirosantilli/_file/python/python/sphinx

To run each example and see the output run:

./build.sh
xdg-open out/index.html

@cirosantilli/_file/python/sphinx/python/sphinx/hello

Minimal example. Gives a hint at how boilerplate heavy Sphinx can be!

@cirosantilli/_file/python/sphinx/python/sphinx/union

stackoverflow.com/questions/34647966/how-to-express-multiple-types-for-a-single-parameter-or-a-return-value-in-docstr/40801906#40801906

@cirosantilli/_file/python/sphinx/python/sphinx/class

Basic class example.

@cirosantilli/_file/python/sphinx/python/sphinx/virtual_method

Polymorphism example:

 Ancestors (10)

 Synonyms (1)

cirosantilli/sphinx-python

View article source

Discussion (0)

There are no discussions about this article yet.

Articles by others on the same topic (0)

There are currently no matching articles.

See all articles in the same topic Create my own version