Test Module for sphinx_rtd_theme.
Docstring for class Foo.
This text tests for the formatting of docstrings generated from output
sphinx.ext.autodoc. Which contain reST, but sphinx nests it in the
<tt>is used for class, method names and etc, but those will always have the
<tt>(like the <tt> I just wrote here) needs to be shown with the same style as anything else with
``this type of markup``.
It’s common for programmers to give a code example inside of their docstring:
from test_py_module import Foo myclass = Foo() myclass.dothismethod('with this argument') myclass.flush() print(myclass)
Start the Foo.
- qux (string) – The first argument to initialize class.
- spam (bool) – Spam me yes or no…
list of weak references to the object (if defined)
Return the added values.
- val1 (int) – First number to add.
- val2 (int) – Second number to add.
another_function(a, b, **kwargs)¶
Here is another function.
- a (int) – The number of green hats you own.
- b (int) – The number of non-green hats you own.
- kwargs (float) – Additional keyword arguments. Each keyword parameter should specify the name of your favorite cuisine. The values should be floats, specifying the mean price of your favorite dish in that cooking style.
A 2-tuple. The first element is the mean price of all dishes across cuisines. The second element is the total number of hats you own: \(a + b\).
ValueError – When
ais not an integer.
New in version 1.0: This was added in 1.0
Changed in version 2.0: This was changed in 2.0
Deprecated since version 3.0: This is deprecated since 3.0
Doc comment for class attribute Foo.bar. It can have multiple lines.
Docstring for class attribute Foo.baz.
Return a string as uppercase.
Parameters: myvalue (string) – String to change Return type: string
Doc comment for Foo.flox. One line only.
Doc comment for instance attribute qux.
Docstring for instance attribute spam.
At this point optional parameters cannot be generated from code. However, some projects will manually do it, like so:
This example comes from django-payments module docs.
DotpayProvider(seller_id, pin[, channel=0[, lock=False], lang='pl'])¶
This backend implements payments using a popular Polish gateway, Dotpay.pl.
Due to API limitations there is no support for transferring purchased items.
- seller_id – Seller ID assigned by Dotpay
- pin – PIN assigned by Dotpay
- channel – Default payment channel (consult reference guide)
- lang – UI language
- lock – Whether to disable channels other than the default selected above