OurBigBook
About
$
Donate
Sign in
Sign up
by
Ciro Santilli
(@cirosantilli,
32
)
Sphinx (documentation generator)
Table of contents
@cirosantilli/_file/python/python/sphinx
@cirosantilli/_file/python/sphinx/python/sphinx/hello
@cirosantilli/_file/python/sphinx/python/sphinx/union
@cirosantilli/_file/python/sphinx/python/sphinx/class
@cirosantilli/_file/python/sphinx/python/sphinx/virtual_method
@cirosantilli/_file/python/python/sphinx
Sphinx
(root)
/
@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
Sphinx
(root)
/
@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
Sphinx
(root)
/
@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
Sphinx
(root)
/
@cirosantilli
/
_file
/
python
/
sphinx
/
python
/
sphinx
/
class
Basic class example.
@cirosantilli/_file/python/sphinx/python/sphinx/virtual_method
Sphinx
(root)
/
@cirosantilli
/
_file
/
python
/
sphinx
/
python
/
sphinx
/
virtual_method
Polymorphism
example:
stackoverflow.com/questions/4714136/how-to-implement-virtual-methods-in-python/38717503#38717503
stackoverflow.com/questions/17841323/how-to-annotate-a-member-as-abstract-in-sphinx-documentation/75634909#75634909
Ancestors
Python documentation generator
Python
List of programming languages
Programming language
Software
Computer
Information technology
Area of technology
Technology
Index
Synonyms
cirosantilli/sphinx-python
Discussion (0)
Subscribe (1)
Sign up
or
sign in
create discussions.
There are no discussions about this article yet.
View article source