by

Ciro Santilli (@cirosantilli, 32)

Python documentation generator

Table of contents
- Sphinx

Sphinx (documentation generator)

@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

Discussion (0)

Sign up or sign in create discussions.

There are no discussions about this article yet.

View article source