mirror of
https://github.com/readthedocs/sphinx-autoapi
synced 2024-11-11 19:10:58 +00:00
70 lines
1.7 KiB
Python
70 lines
1.7 KiB
Python
"""Example module
|
|
|
|
This is a description
|
|
"""
|
|
|
|
from ._private_module import PrivateClass as PublicClass
|
|
from ._subpackage import module_level_method
|
|
|
|
__all__ = ["PublicClass", "Foo"]
|
|
|
|
|
|
class Foo(object):
|
|
|
|
class_var = 42 #: Class var docstring
|
|
|
|
another_class_var = 42
|
|
"""Another class var docstring"""
|
|
|
|
class Meta(object):
|
|
"""A nested class just to test things out"""
|
|
|
|
@classmethod
|
|
def foo():
|
|
"""The foo class method"""
|
|
return True
|
|
|
|
def method_okay(self, foo=None, bar=None):
|
|
"""This method should parse okay"""
|
|
return True
|
|
|
|
def method_multiline(self, foo=None, bar=None, baz=None):
|
|
"""This is on multiple lines, but should parse okay too
|
|
|
|
pydocstyle gives us lines of source. Test if this means that multiline
|
|
definitions are covered in the way we're anticipating here
|
|
"""
|
|
return True
|
|
|
|
def method_tricky(self, foo=None, bar=dict(foo=1, bar=2)):
|
|
"""This will likely fail our argument testing
|
|
|
|
We parse naively on commas, so the nested dictionary will throw this off
|
|
"""
|
|
return True
|
|
|
|
def method_sphinx_docs(self, foo, bar=0):
|
|
"""This method is documented with sphinx style docstrings.
|
|
|
|
:param foo: The first argument.
|
|
:type foo: int
|
|
|
|
:param int bar: The second argument.
|
|
|
|
:returns: The sum of foo and bar.
|
|
:rtype: int
|
|
"""
|
|
return foo + bar
|
|
|
|
def method_google_docs(self, foo, bar=0):
|
|
"""This method is documented with google style docstrings.
|
|
|
|
Args:
|
|
foo (int): The first argument.
|
|
bar (int): The second argument.
|
|
|
|
Returns:
|
|
int: The sum of foo and bar.
|
|
"""
|
|
return foo + bar
|