Example library

This document contains the reference documentation of a dummy library used in sphinx-codeautolink’s documentation. Besides providing valid hyperlink targets, it also demonstrates the default autodoc integration.

Expand for references to lib

Examples / Basic use

Examples / Concatenating examples

Examples / Doctest code blocks

Examples / IPython blocks and notebooks

sphinx-codeautolink

class lib.Knight

Expand for references to lib.Knight

Examples / Basic use

Examples / Concatenating examples

Examples / Doctest code blocks

Examples / Invisible imports

Examples / IPython blocks and notebooks

sphinx-codeautolink

limbs: int = 4

scratch()

Scratch the knight.

Expand for references to lib.Knight.scratch

Examples / Basic use

Examples / Concatenating examples

sphinx-codeautolink

Return type:

None

taunt()

Knight taunts the adversary.

Expand for references to lib.Knight.taunt

Examples / Basic use

Examples / Concatenating examples

Examples / Invisible imports

Examples / IPython blocks and notebooks

sphinx-codeautolink

Return type:

str

taunts: List[str] = ['None shall pass!', "'Tis but a scratch!", "It's just a flesh wound... Chicken!", "Right, I'll do you for that!", 'Oh, I see, running away?']

class lib.Shrubbery(looks_nice, too_expensive)

A shrubbery bought in town.

Expand for references to lib.Shrubbery

Examples / Basic use

Parameters:

• looks_nice (bool) –

• too_expensive (bool) –

looks_nice: bool

too_expensive: bool