AutomodsummEntry
- class plasmapy_sphinx.automodsumm.generate.AutomodsummEntry(name: str, path: str | None, template: str, recursive: bool)[source]
Bases:
AutosummaryEntry
A typed version of
namedtuple
representing an stub file entry forautomodsumm
.- Parameters:
name (
str
) – The objects fully qualified name of the object for which the stub file will be generated.path (
str
) – Absolute file path to the toctree directory. This is where the stub file will be placed.recursive (
bool
) – Specifies if stub file for modules and and sub-packages should be generated.template (
str
) – Name of the template file to be used in generating the stub file.
Create new instance of AutosummaryEntry(name, path, template, recursive)
Attributes Summary
Alias for field number 0
Alias for field number 1
Alias for field number 3
Alias for field number 2
Methods Summary
count
(value, /)Return number of occurrences of value.
index
(value[, start, stop])Return first index of value.
Attributes Documentation
Methods Documentation
- count(value, /)
Return number of occurrences of value.
- index(value, start=0, stop=9223372036854775807, /)
Return first index of value.
Raises ValueError if the value is not present.