Test Module for sphinx_rtd_theme.
test_py_module.test.
Foo
(qux, spam=False)[source]¶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
<dl>
, and <dt>
tags. Also, <tt>
is used for class, method
names and etc, but those will always have the .descname
or
.descclassname
class.
Normal <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:
myclass = Foo()
myclass.dothismethod('with this argument')
myclass.flush()
Here is a link to capitalize()
.
Here is a link to __init__()
.
add
(val1, val2)[source]¶Return the added values.
Parameters: |
|
---|---|
Return type: | int |
another_function
(a, b, **kwargs)[source]¶Here is another function.
Parameters: |
|
---|---|
Returns: | 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\). |
Return type: | tuple |
Raises: | ValueError – When |
bar
= 1¶Doc comment for class attribute Foo.bar. It can have multiple lines.
baz
= 2¶Docstring for class attribute Foo.baz.
capitalize
(myvalue)[source]¶Return a string as uppercase.
Parameters: | myvalue (string) – String to change |
---|---|
Return type: | string |
flox
= 1.5¶Doc comment for Foo.flox. One line only.
qux
= None¶Doc comment for instance attribute qux.
spam
= None¶Docstring for instance attribute spam.