22 lines
598 B
ReStructuredText
22 lines
598 B
ReStructuredText
Documentation, how to use Sphinx and reStructuredText
|
|
##################################################################
|
|
|
|
Documenting code can be both fun and useful! ...
|
|
|
|
Additionally, adding ...
|
|
|
|
... So that typing `Spam.eggs.` will automatically ...
|
|
|
|
Topics covered in this chapter are as follows:
|
|
|
|
- The reStructuredText syntax
|
|
- Setting up documentation using Sphinx
|
|
- Sphinx style docstrings
|
|
- Google style docstrings
|
|
- NumPy style docstrings
|
|
|
|
The reStructuredText syntax
|
|
******************************************************************
|
|
|
|
The reStructuredText format (also known as ...
|