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.
- class lib.Knight
- limbs: int = 4
- scratch()
Scratch the knight.
Expand for references to
lib.Knight.scratch
- Return type:
None
- taunt()
Knight taunts the adversary.
- 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
- Parameters:
looks_nice (bool)
too_expensive (bool)
- looks_nice: bool
- too_expensive: bool