Skip to content

mkdocs_demo.config

config module

config

This module contains MkDocstrings configuration objects.

RefGenConfig dataclass

Dataclass to store MkDocstrings configuration.

handler class-attribute instance-attribute 

handler: Language = PYTHON

Handler language.

out_dir class-attribute instance-attribute 

out_dir: Path = Path('reference')

Output directory.

interfaces

This module contains interfaces and custom types.

ITrolling 

ITrolling(x: float, n: int)

Abstract base class for implementing trolling interface.

Parameters

x : float The parameter x is a float, which means it can hold decimal values. It is used to store a numerical value.

n : int The parameter n is an integer that represents the number of iterations or steps in a process.

Source code in src/mkdocs_demo/config/interfaces.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def __init__(self, x: float, n: int) -> None:
    """
    The above function is an initializer method for a class that takes in
    two parameters, `x` and `n`, and does not return anything.

    Parameters
    ----------
    `x` : `float`
        The parameter `x` is a float, which means it can hold decimal
        values. It is used to store a numerical value.

    `n` : `int`
        The parameter `n` is an integer that represents the number of
        iterations or steps in a process.
    """

    self.x = x
    self.n = n

n instance-attribute 

n = n

x instance-attribute 

x = x

__repr__ 

__repr__() -> str
Source code in src/mkdocs_demo/config/interfaces.py 
51
52
def __repr__(self) -> str:
    return f"""{self.x} * {self.n} = {self.multiple}"""

__str__ 

__str__() -> str
Source code in src/mkdocs_demo/config/interfaces.py 
48
49
def __str__(self) -> str:
    return f"""x={self.x}, n={self.n}, hence the multiple={self.multiple}"""

from_dict abstractmethod 

from_dict(d: dict[str, int]) -> Self
Source code in src/mkdocs_demo/config/interfaces.py 
59
60
61
@abstractmethod
def from_dict(cls, d: dict[str, int]) -> Self:
    pass

multiple abstractmethod 

multiple() -> float
Source code in src/mkdocs_demo/config/interfaces.py 
54
55
56
57
@abstractproperty
@abstractmethod
def multiple(self) -> float:
    pass

Language

Bases: Enum

Enum that represents different programming languages.

BASH class-attribute instance-attribute 

BASH: str = '*.sh'

Bash language.

PYTHON class-attribute instance-attribute 

PYTHON: str = '*.py'

Python language.

trivial

This module contains extreme triviality.

trivial_function 

trivial_function() -> Literal['OMG, thanks!']

Thanks for that.

Returns

Literal Absolutely useless string literal.

Source code in src/mkdocs_demo/config/trivial.py 
 7
 8
 9
10
11
12
13
14
15
16
17
def trivial_function() -> Literal["OMG, thanks!"]:
    """
    Thanks for that.

    Returns
    -------
    `Literal`
        Absolutely useless string literal.
    """

    return "OMG, thanks!"