File: submodule.py

package info (click to toggle)
sphinx-autoapi 3.3.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 900 kB
  • sloc: python: 5,146; makefile: 7
file content (41 lines) | stat: -rw-r--r-- 741 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
"""Example module

This is a description
"""

DATA = 42


def function(foo, bar):
    """A module level function"""


def _private_function():
    """A function that shouldn't get rendered."""


def not_in_all_function():
    """A function that doesn't exist in __all__ when imported."""


class Class:
    """This is a class."""

    class_var = 42
    """Class var docstring"""

    class NestedClass:
        """A nested class just to test things out"""

        @classmethod
        def a_classmethod():
            """A class method"""
            return True

    def method_okay(self, foo=None, bar=None):
        """This method should parse okay"""
        return True


class MyException(Exception):
    """This is an exception."""