SYMBOL INDEX (709 symbols across 57 files) FILE: noxfile.py function tests (line 11) | def tests(session: Session) -> None: function typecheck_ts (line 28) | def typecheck_ts(session: Session, typedoc: str) -> None: function test_typedoc (line 41) | def test_typedoc(session: Session, typedoc: str) -> None: function test_sphinx_6 (line 82) | def test_sphinx_6(session: Session) -> None: FILE: sphinx_js/__init__.py function make_css_file (line 18) | def make_css_file(app: Sphinx) -> None: function on_build_finished (line 32) | def on_build_finished(app: Sphinx, exc: Exception | None) -> None: function setup (line 38) | def setup(app: Sphinx) -> None: function analyze (line 72) | def analyze(app: Sphinx) -> None: function root_or_fallback (line 105) | def root_or_fallback( FILE: sphinx_js/analyzer_utils.py function program_name_on_this_platform (line 14) | def program_name_on_this_platform(program: str) -> str: function search_node_modules (line 21) | def search_node_modules(cmdname: str, cmdpath: str, dir: str | Path) -> ... class Command (line 44) | class Command: method __init__ (line 45) | def __init__(self, program: str): method add (line 49) | def add(self, *args: str) -> None: method make (line 52) | def make(self) -> list[str]: function cache_to_file (line 60) | def cache_to_file( function is_explicitly_rooted (line 88) | def is_explicitly_rooted(path: str) -> bool: function dotted_path (line 99) | def dotted_path(segments: Sequence[str]) -> str: FILE: sphinx_js/directives.py function unescape (line 50) | def unescape(escaped: str) -> str: function _members_to_exclude (line 60) | def _members_to_exclude(arg: str | None) -> set[str]: function sphinx_js_type_role (line 70) | def sphinx_js_type_role( # type: ignore[no-untyped-def] class JSXrefMixin (line 99) | class JSXrefMixin: method make_xref (line 100) | def make_xref( class JSTypedField (line 125) | class JSTypedField(JSXrefMixin, TypedField): class JSGroupedField (line 129) | class JSGroupedField(JSXrefMixin, GroupedField): function fix_js_make_xref (line 135) | def fix_js_make_xref() -> None: function fix_staticfunction_objtype (line 168) | def fix_staticfunction_objtype() -> None: function add_type_param_field_to_directives (line 177) | def add_type_param_field_to_directives() -> None: class JsDirective (line 190) | class JsDirective(Directive): method _run (line 200) | def _run(self, renderer_class: type[Renderer], app: Sphinx) -> list[No... class JsDirectiveWithChildren (line 206) | class JsDirectiveWithChildren(JsDirective): function note_dependencies (line 219) | def note_dependencies(app: Sphinx, dependencies: Iterable[str]) -> None: function auto_function_directive_bound_to_app (line 235) | def auto_function_directive_bound_to_app(app: Sphinx) -> type[Directive]: function auto_class_directive_bound_to_app (line 250) | def auto_class_directive_bound_to_app(app: Sphinx) -> type[Directive]: function auto_attribute_directive_bound_to_app (line 266) | def auto_attribute_directive_bound_to_app(app: Sphinx) -> type[Directive]: class desc_js_type_parameter_list (line 280) | class desc_js_type_parameter_list(nodes.Part, nodes.Inline, nodes.FixedT... method astext (line 289) | def astext(self) -> str: function html5_visit_desc_js_type_parameter_list (line 293) | def html5_visit_desc_js_type_parameter_list( function html5_depart_desc_js_type_parameter_list (line 313) | def html5_depart_desc_js_type_parameter_list( function text_visit_desc_js_type_parameter_list (line 326) | def text_visit_desc_js_type_parameter_list( function text_depart_desc_js_type_parameter_list (line 337) | def text_depart_desc_js_type_parameter_list( function latex_visit_desc_type_parameter_list (line 347) | def latex_visit_desc_type_parameter_list( function latex_depart_desc_type_parameter_list (line 353) | def latex_depart_desc_type_parameter_list( function add_param_list_to_signode (line 359) | def add_param_list_to_signode(signode: desc_signature, params: str) -> N... function handle_typeparams_for_signature (line 366) | def handle_typeparams_for_signature( class JSFunction (line 395) | class JSFunction(JSCallable): method get_display_prefix (line 404) | def get_display_prefix( method handle_signature (line 418) | def handle_signature(self, sig: str, signode: desc_signature) -> tuple... class JSInterface (line 422) | class JSInterface(JSCallable): method get_display_prefix (line 430) | def get_display_prefix(self) -> list[Node]: method handle_signature (line 436) | def handle_signature(self, sig: str, signode: desc_signature) -> tuple... class JSTypeAlias (line 440) | class JSTypeAlias(JSObject): method handle_signature (line 450) | def handle_signature(self, sig: str, signode: desc_signature) -> tuple... class JSClass (line 454) | class JSClass(JSConstructor): method handle_signature (line 455) | def handle_signature(self, sig: str, signode: desc_signature) -> tuple... function patch_JsObject_get_index_text (line 460) | def patch_JsObject_get_index_text() -> None: function auto_module_directive_bound_to_app (line 475) | def auto_module_directive_bound_to_app(app: Sphinx) -> type[Directive]: function auto_summary_directive_bound_to_app (line 485) | def auto_summary_directive_bound_to_app(app: Sphinx) -> type[Directive]: function add_directives (line 495) | def add_directives(app: Sphinx) -> None: FILE: sphinx_js/ir.py class TypeXRefIntrinsic (line 38) | class TypeXRefIntrinsic: class TypeXRefInternal (line 44) | class TypeXRefInternal: class TypeXRefExternal (line 52) | class TypeXRefExternal: class DescriptionName (line 65) | class DescriptionName: class DescriptionText (line 71) | class DescriptionText: class DescriptionCode (line 77) | class DescriptionCode: class Pathname (line 90) | class Pathname: method __init__ (line 97) | def __init__(self, segments: Sequence[str]): method __str__ (line 100) | def __str__(self) -> str: method __repr__ (line 103) | def __repr__(self) -> str: method __eq__ (line 106) | def __eq__(self, other: Any) -> bool: method dotted (line 109) | def dotted(self) -> str: class _NoDefault (line 114) | class _NoDefault: method __repr__ (line 121) | def __repr__(self) -> str: class _Member (line 129) | class _Member: class TypeParam (line 147) | class TypeParam: class Param (line 154) | class Param: method __attrs_post_init__ (line 172) | def __attrs_post_init__(self) -> None: class Exc (line 180) | class Exc: class Return (line 189) | class Return: class Module (line 198) | class Module: class TopLevel (line 211) | class TopLevel: class Attribute (line 268) | class Attribute(TopLevel, _Member): class Function (line 283) | class Function(TopLevel, _Member): class _MembersAndSupers (line 295) | class _MembersAndSupers: class Interface (line 309) | class Interface(TopLevel, _MembersAndSupers): class Class (line 317) | class Class(TopLevel, _MembersAndSupers): class TypeAlias (line 334) | class TypeAlias(TopLevel): function json_to_ir (line 347) | def json_to_ir(json: Any) -> list[TopLevelUnion]: function _structure (line 364) | def _structure(*types: Any) -> Callable[[Callable[P, T]], Callable[P, T]]: function structure_description (line 374) | def structure_description(x: Any, _: Any) -> Description | bool: function get_type_literal (line 382) | def get_type_literal(t: type[DescriptionText]) -> str: function structure_description_item (line 396) | def structure_description_item(x: Any, _: Any) -> DescriptionItem: function structure_type (line 402) | def structure_type(x: Any, _: Any) -> Type: function structure_str_or_xref (line 409) | def structure_str_or_xref(x: Any, _: Any) -> Type: function structure_str_or_nodefault (line 416) | def structure_str_or_nodefault(x: Any, _: Any) -> str | _NoDefault: FILE: sphinx_js/js/cli.ts class ExitError (line 25) | class ExitError extends Error { method constructor (line 27) | constructor(code: number) { function bootstrapAppTypedoc0_25 (line 33) | async function bootstrapAppTypedoc0_25(args: string[]): Promise { function loadConfig (line 61) | async function loadConfig( function typedocConvert (line 71) | async function typedocConvert(app: Application): Promise { method constructor (line 53) | constructor( method addTypeArguments (line 69) | addTypeArguments( method convert (line 89) | convert(type: SomeType, context: TypeContext): Type { method conditional (line 98) | conditional(type: ConditionalType): Type { method indexedAccess (line 109) | indexedAccess(type: IndexedAccessType): Type { method inferred (line 117) | inferred(type: InferredType): Type { method intersection (line 126) | intersection(type: IntersectionType): Type { method intrinsic (line 135) | intrinsic(type: IntrinsicType): Type { method literal (line 138) | literal(type: LiteralType): Type { method mapped (line 144) | mapped(type: MappedType): Type { method optional (line 182) | optional(type: OptionalType): Type { method predicate (line 188) | predicate(type: PredicateType): Type { method query (line 198) | query(type: QueryType): Type { method convertPrivateReferenceToReflection (line 208) | convertPrivateReferenceToReflection(type: ReferenceType): Type | undef... method convertReferenceToXRef (line 258) | convertReferenceToXRef(type: ReferenceType): Type { method reference (line 307) | reference(type: ReferenceType): Type { method reflection (line 322) | reflection(type: ReflectionType): Type { method rest (line 337) | rest(type: RestType): Type { method templateLiteral (line 340) | templateLiteral(type: TemplateLiteralType): Type { method tuple (line 355) | tuple(type: TupleType): Type { method namedTupleMember (line 366) | namedTupleMember(type: NamedTupleMember): Type { method typeOperator (line 371) | typeOperator(type: TypeOperatorType): Type { method union (line 378) | union(type: UnionType): Type { method unknown (line 387) | unknown(type: UnknownType): Type { method array (line 392) | array(t: ArrayType): Type { method convertSignature (line 398) | convertSignature(sig: SignatureReflection): Type { method convertTypeLiteral (line 417) | convertTypeLiteral(lit: DeclarationReflection): Type { function convertType (line 462) | function convertType( function convertTypeLiteral (line 476) | function convertTypeLiteral( function referenceToXRef (line 489) | function referenceToXRef( FILE: sphinx_js/js/importHooks.mjs function tryResolve (line 1) | async function tryResolve(specifier, context, nextResolve) { function resolve (line 14) | async function resolve(specifier, context, nextResolve) { FILE: sphinx_js/js/ir.ts type TypeXRefIntrinsic (line 4) | type TypeXRefIntrinsic = { function intrinsicType (line 9) | function intrinsicType(name: string): TypeXRefIntrinsic { type TypeXRefInternal (line 16) | type TypeXRefInternal = { type TypeXRefExternal (line 22) | type TypeXRefExternal = { type TypeXRef (line 30) | type TypeXRef = TypeXRefExternal | TypeXRefInternal | TypeXRefIntrinsic; type Type (line 31) | type Type = (string | TypeXRef)[]; type DescriptionName (line 33) | type DescriptionName = { type DescriptionText (line 38) | type DescriptionText = { type DescriptionCode (line 43) | type DescriptionCode = { type DescriptionItem (line 48) | type DescriptionItem = type Description (line 52) | type Description = DescriptionItem[]; type Pathname (line 54) | type Pathname = string[]; type NoDefault (line 56) | type NoDefault = { _no_default: true }; constant NO_DEFAULT (line 57) | const NO_DEFAULT: NoDefault = { _no_default: true }; type Member (line 59) | type Member = { type TypeParam (line 66) | type TypeParam = { type Param (line 72) | type Param = { type Return (line 81) | type Return = { type Module (line 86) | type Module = { type TopLevel (line 96) | type TopLevel = { type Attribute (line 113) | type Attribute = TopLevel & type IRFunction (line 120) | type IRFunction = TopLevel & type _MembersAndSupers (line 130) | type _MembersAndSupers = { type Interface (line 135) | type Interface = TopLevel & type Class (line 141) | type Class = TopLevel & type TypeAlias (line 150) | type TypeAlias = TopLevel & { type TopLevelIR (line 156) | type TopLevelIR = Attribute | IRFunction | Class | Interface | TypeAlias; FILE: sphinx_js/js/main.ts function main (line 4) | async function main() { FILE: sphinx_js/js/redirectPrivateAliases.ts type SymbolToTypeKey (line 42) | type SymbolToTypeKey = `${string}:${number}` | `${string}:${string}`; type SymbolToType (line 43) | type SymbolToType = Map; type ReadonlySymbolToType (line 44) | type ReadonlySymbolToType = ReadonlyMap; function getOwningModule (line 49) | function getOwningModule(context: Context): Reflection { function redirectPrivateTypes (line 62) | function redirectPrivateTypes(app: Application): ReadonlySymbolToType { FILE: sphinx_js/js/sphinxJsConfig.ts type SphinxJsConfig (line 9) | type SphinxJsConfig = { FILE: sphinx_js/js/typedocPatches.ts type TypeDocOptionMap (line 3) | interface TypeDocOptionMap { type Application (line 6) | interface Application { FILE: sphinx_js/js/typedocPlugin.ts function load (line 8) | async function load(app: any): Promise { FILE: sphinx_js/jsdoc.py class JsDocCode (line 43) | class JsDocCode(TypedDict, total=False): class Meta (line 47) | class Meta(TypedDict, total=False): class JsdocType (line 54) | class JsdocType(TypedDict, total=False): class Doclet (line 58) | class Doclet(TypedDict, total=False): class Analyzer (line 79) | class Analyzer: method __init__ (line 85) | def __init__(self, json: list[Doclet], base_dir: str): method from_disk (line 131) | def from_disk( method get_object (line 143) | def get_object( method _doclet_as_class (line 172) | def _doclet_as_class(self, doclet: Doclet, full_path: Sequence[str]) -... method _doclet_as_function (line 203) | def _doclet_as_function(self, doclet: Doclet, full_path: Sequence[str]... method _doclet_as_attribute (line 218) | def _doclet_as_attribute( function is_private (line 233) | def is_private(doclet: Doclet) -> bool: function is_static (line 237) | def is_static(doclet: Doclet) -> bool: function full_path_segments (line 241) | def full_path_segments( function jsdoc_output (line 273) | def jsdoc_output( function format_default_according_to_type_hints (line 313) | def format_default_according_to_type_hints( function description (line 355) | def description(obj: Doclet) -> str: function get_type (line 359) | def get_type(props: Doclet) -> str | None: function top_level_properties (line 367) | def top_level_properties( function properties_to_ir (line 396) | def properties_to_ir(properties: list[Doclet]) -> list[Attribute]: function first_type_is_string (line 423) | def first_type_is_string(type: JsdocType) -> bool: function params_to_ir (line 428) | def params_to_ir(doclet: Doclet) -> list[Param]: function exceptions_to_ir (line 484) | def exceptions_to_ir(exceptions: list[Doclet]) -> list[Exc]: function returns_to_ir (line 489) | def returns_to_ir(returns: list[Doclet]) -> list[Return]: FILE: sphinx_js/parsers.py class PathVisitor (line 30) | class PathVisitor(NodeVisitor): # type:ignore[type-arg] method visit_path_and_formal_params (line 33) | def visit_path_and_formal_params(self, node, children): method visit_name (line 36) | def visit_name(self, node, children): method visit_sep (line 41) | def visit_sep(self, node, children): method visit_path (line 44) | def visit_path(self, node, children): method visit_name_and_sep (line 51) | def visit_name_and_sep(self, node, children): method visit_formal_params (line 55) | def visit_formal_params(self, node, children): method visit_relative_dir (line 58) | def visit_relative_dir(self, node, children): method visit_cur_dir (line 62) | def visit_cur_dir(self, node, children): method visit_middle_segments (line 65) | def visit_middle_segments(self, node, children): method generic_visit (line 68) | def generic_visit(self, node, visited_children): function _backslash_unescape (line 74) | def _backslash_unescape(str): FILE: sphinx_js/renderers.py function new_document_from_parent (line 54) | def new_document_from_parent( function sort_attributes_first_then_by_path (line 67) | def sort_attributes_first_then_by_path(obj: TopLevel) -> Any: function _members_to_include_inner (line 80) | def _members_to_include_inner( function members_to_include (line 120) | def members_to_include( function unwrapped (line 134) | def unwrapped(text: str) -> str: function render_description (line 139) | def render_description(description: ir.Description) -> str: class HasDepPath (line 186) | class HasDepPath(Protocol): class Renderer (line 190) | class Renderer: method _parse_path (line 200) | def _parse_path(self, arg: str) -> None: method __init__ (line 210) | def __init__( method from_directive (line 231) | def from_directive(cls: type[R], directive: Directive, app: Sphinx) -> R: method _set_type_xref_formatter (line 250) | def _set_type_xref_formatter( method get_object (line 262) | def get_object(self) -> HasDepPath: method dependencies (line 265) | def dependencies(self) -> set[str]: method rst_nodes (line 279) | def rst_nodes(self) -> list[Node]: class JsRenderer (line 283) | class JsRenderer(Renderer): method _template_vars (line 297) | def _template_vars(self, name: str, obj: TopLevel) -> dict[str, Any]: method lookup_object (line 300) | def lookup_object( method get_object (line 323) | def get_object(self) -> TopLevel: method rst_nodes (line 327) | def rst_nodes(self) -> list[Node]: method rst_for (line 350) | def rst_for(self, obj: TopLevel) -> str: method rst (line 366) | def rst( method _type_params (line 390) | def _type_params(self, obj: Function | Class | TypeAlias | Interface) ... method _formal_params (line 395) | def _formal_params(self, obj: Function) -> str: method render_type (line 430) | def render_type(self, type: Type, escape: bool = False, bold: bool = T... method render_xref (line 466) | def render_xref(self, s: TypeXRef, escape: bool = False) -> str: method _return_formatter (line 486) | def _return_formatter(self, return_: Return) -> tuple[list[str], str]: method _type_param_formatter (line 495) | def _type_param_formatter(self, tparam: TypeParam) -> tuple[list[str],... method _param_formatter (line 503) | def _param_formatter(self, param: Param) -> tuple[list[str], str] | None: method _param_type_formatter (line 514) | def _param_type_formatter(self, param: Param) -> tuple[list[str], str]... method _exception_formatter (line 522) | def _exception_formatter(self, exception: Exc) -> tuple[list[str], str]: method _fields (line 530) | def _fields(self, obj: TopLevel) -> Iterator[tuple[list[str], str]]: class AutoFunctionRenderer (line 563) | class AutoFunctionRenderer(JsRenderer): method _template_vars (line 567) | def _template_vars(self, name: str, obj: Function) -> dict[str, Any]: ... class AutoClassRenderer (line 587) | class AutoClassRenderer(JsRenderer): method _template_vars (line 591) | def _template_vars(self, name: str, obj: Class | Interface) -> dict[st... method _members_of (line 651) | def _members_of( class AutoAttributeRenderer (line 675) | class AutoAttributeRenderer(JsRenderer): method _template_vars (line 679) | def _template_vars(self, name: str, obj: Attribute | TypeAlias) -> dic... class AutoModuleRenderer (line 710) | class AutoModuleRenderer(JsRenderer): method _parse_path (line 711) | def _parse_path(self, arg: str) -> None: method get_object (line 719) | def get_object(self) -> Module: # type:ignore[override] method rst_for_group (line 724) | def rst_for_group(self, objects: Iterable[TopLevel]) -> list[str]: method rst (line 731) | def rst( # type:ignore[override] class AutoSummaryRenderer (line 744) | class AutoSummaryRenderer(Renderer): method _parse_path (line 745) | def _parse_path(self, arg: str) -> None: method get_object (line 753) | def get_object(self) -> Module: method rst_nodes (line 758) | def rst_nodes(self) -> list[Node]: method format_heading (line 775) | def format_heading(self, text: str) -> Node: method extract_summary (line 785) | def extract_summary(self, descr: str) -> str: method get_sig (line 805) | def get_sig(self, obj: TopLevel) -> str: method get_summary_row (line 814) | def get_summary_row(self, pkgname: str, obj: TopLevel) -> tuple[str, s... method get_summary_table (line 832) | def get_summary_table( method format_table (line 846) | def format_table(self, items: list[tuple[str, str, str]]) -> list[Node]: FILE: sphinx_js/suffix_tree.py class _Tree (line 13) | class _Tree(TypedDict, total=False): class SuffixTree (line 18) | class SuffixTree(Generic[T]): method __init__ (line 24) | def __init__(self) -> None: method add (line 35) | def add(self, unambiguous_segments: Sequence[str], value: T) -> None: method add_many (line 51) | def add_many( method get_with_path (line 72) | def get_with_path(self, segments: Sequence[str]) -> tuple[T, Sequence[... method get (line 122) | def get(self, segments: Sequence[str]) -> T: class SuffixError (line 126) | class SuffixError(Exception): method __init__ (line 127) | def __init__(self, segments: Sequence[str]): method __str__ (line 132) | def __str__(self) -> str: class PathTaken (line 136) | class PathTaken(SuffixError): class PathsTaken (line 142) | class PathsTaken(Exception): method __init__ (line 149) | def __init__(self, conflicts: list[Sequence[str]]) -> None: method __str__ (line 155) | def __str__(self) -> str: class SuffixNotFound (line 166) | class SuffixNotFound(SuffixError): class SuffixAmbiguous (line 172) | class SuffixAmbiguous(SuffixError): method __init__ (line 175) | def __init__( method __str__ (line 185) | def __str__(self) -> str: FILE: sphinx_js/typedoc.py function typedoc_version_info (line 29) | def typedoc_version_info(typedoc: str) -> tuple[tuple[int, ...], tuple[i... function version_to_str (line 46) | def version_to_str(t: Sequence[int]) -> str: function typedoc_output (line 50) | def typedoc_output( class Analyzer (line 109) | class Analyzer: method __init__ (line 114) | def __init__( method get_object (line 125) | def get_object( method from_disk (line 137) | def from_disk( method _get_toplevel_objects (line 150) | def _get_toplevel_objects( method _create_modules (line 159) | def _create_modules(self, ir_objects: Sequence[ir.TopLevel]) -> Iterab... FILE: tests/conftest.py function rootdir (line 36) | def rootdir(): FILE: tests/roots/test-incremental_js/a.js class ClassA (line 4) | class ClassA { method noUseOfThis (line 8) | static noUseOfThis() {} method methodA (line 13) | methodA() {} FILE: tests/roots/test-incremental_js/inner/b.js class ClassB (line 4) | class ClassB { method noUseOfThis (line 8) | static noUseOfThis() {} method methodB (line 13) | methodB() {} FILE: tests/roots/test-incremental_ts/a.ts class ClassA (line 1) | class ClassA { method constructor (line 2) | constructor() {} method methodA (line 7) | methodA() {} FILE: tests/roots/test-incremental_ts/inner/b.ts class ClassB (line 1) | class ClassB { method constructor (line 2) | constructor() {} method methodB (line 7) | methodB() {} FILE: tests/test.ts function joinType (line 7) | function joinType(t: Type): string { function resolveFile (line 11) | function resolveFile(path: string): string { function getObject (line 33) | function getObject(name: string): TopLevelIR { FILE: tests/test_build_js/source/code.js function linkDensity (line 10) | function linkDensity(node) { class ContainingClass (line 22) | class ContainingClass { method constructor (line 28) | constructor(ho) { method someMethod (line 39) | someMethod(hi) {} method bar (line 44) | get bar() { method bar (line 47) | set bar(baz) { method anotherMethod (line 54) | anotherMethod() {} method yetAnotherMethod (line 59) | yetAnotherMethod() {} method secret (line 65) | secret() {} class ClosedClass (line 70) | class ClosedClass { method publical (line 74) | publical() {} method publical2 (line 79) | publical2() {} method publical3 (line 84) | publical3() {} class NonAlphabetical (line 88) | class NonAlphabetical { method z (line 90) | z() {} method a (line 93) | a() {} function shadow (line 103) | function shadow() {} function exampleTag (line 123) | function exampleTag() {} class ExampleClass (line 132) | class ExampleClass {} function destructuredParams (line 149) | function destructuredParams(p1, { foo, bar }) {} function injection (line 156) | function injection() {} function defaultsDocumentedInDoclet (line 166) | function defaultsDocumentedInDoclet(func, str, strNum, strBool, num, nil... function defaultsDocumentedInCode (line 174) | function defaultsDocumentedInCode( function variadicParameter (line 186) | function variadicParameter(a, ...args) {} function deprecatedFunction (line 189) | function deprecatedFunction() {} function deprecatedExplanatoryFunction (line 191) | function deprecatedExplanatoryFunction() {} class DeprecatedClass (line 199) | class DeprecatedClass {} class DeprecatedExplanatoryClass (line 201) | class DeprecatedExplanatoryClass {} function seeFunction (line 208) | function seeFunction() {} class SeeClass (line 220) | class SeeClass {} function union (line 225) | function union(fnodeA) {} function longDescriptions (line 237) | function longDescriptions(a, b) {} class SimpleClass (line 242) | class SimpleClass { method staticMethod (line 248) | static staticMethod() {} method nonStaticMethod (line 255) | nonStaticMethod() {} FILE: tests/test_build_js/source/more_code.js function shadow (line 4) | function shadow() {} FILE: tests/test_build_js/test_build_js.py class Tests (line 12) | class Tests(SphinxBuildTestCase): method test_autofunction_minimal (line 23) | def test_autofunction_minimal(self): method test_autofunction_explicit (line 30) | def test_autofunction_explicit(self): method test_autofunction_short (line 39) | def test_autofunction_short(self): method test_autofunction_long (line 43) | def test_autofunction_long(self): method test_autofunction_typedef (line 50) | def test_autofunction_typedef(self): method test_autofunction_callback (line 57) | def test_autofunction_callback(self): method test_autofunction_example (line 64) | def test_autofunction_example(self): method test_autofunction_destructured_params (line 75) | def test_autofunction_destructured_params(self): method test_autofunction_defaults_in_doclet (line 88) | def test_autofunction_defaults_in_doclet(self): method test_autofunction_defaults_in_code (line 100) | def test_autofunction_defaults_in_code(self): method test_autofunction_variadic (line 108) | def test_autofunction_variadic(self): method test_autofunction_deprecated (line 115) | def test_autofunction_deprecated(self): method test_autofunction_see (line 127) | def test_autofunction_see(self): method test_autofunction_static (line 138) | def test_autofunction_static(self): method test_autoclass (line 162) | def test_autoclass(self): method test_autoclass_members (line 169) | def test_autoclass_members(self): method test_autoclass_members_list (line 208) | def test_autoclass_members_list(self): method test_autoclass_members_list_star (line 216) | def test_autoclass_members_list_star(self): method test_autoclass_alphabetical (line 252) | def test_autoclass_alphabetical(self): method test_autoclass_private_members (line 259) | def test_autoclass_private_members(self): method test_autoclass_exclude_members (line 265) | def test_autoclass_exclude_members(self): method test_autoclass_example (line 273) | def test_autoclass_example(self): method test_autoclass_deprecated (line 284) | def test_autoclass_deprecated(self): method test_autoclass_see (line 296) | def test_autoclass_see(self): method test_autoattribute (line 307) | def test_autoattribute(self): method test_autoattribute_example (line 311) | def test_autoattribute_example(self): method test_autoattribute_deprecated (line 322) | def test_autoattribute_deprecated(self): method test_autoattribute_see (line 334) | def test_autoattribute_see(self): method test_getter_setter (line 345) | def test_getter_setter(self): method test_no_shadowing (line 352) | def test_no_shadowing(self): method test_restructuredtext_injection (line 359) | def test_restructuredtext_injection(self): method test_union_types (line 377) | def test_union_types(self): method test_field_list_unwrapping (line 390) | def test_field_list_unwrapping(self): FILE: tests/test_build_ts/source/class.ts class ClassDefinition (line 4) | class ClassDefinition { method constructor (line 11) | constructor(simple: number) {} method method1 (line 17) | method1(simple: number): void {} method anotherMethod (line 22) | anotherMethod() {} type Interface (line 25) | interface Interface {} method constructor (line 32) | constructor() { type InterfaceWithSupers (line 37) | interface InterfaceWithSupers extends Interface {} class ExportedClass (line 39) | class ExportedClass { method constructor (line 40) | constructor() {} class ConstructorlessClass (line 43) | class ConstructorlessClass {} type OptionalThings (line 45) | interface OptionalThings { function blah (line 65) | function blah(a: OptionalThings): ConstructorlessClass { function thunk (line 69) | function thunk(b: typeof blah) {} function selfReferential (line 75) | function selfReferential(b: typeof selfReferential) {} function deprecatedFunction1 (line 80) | function deprecatedFunction1() {} function deprecatedFunction2 (line 85) | function deprecatedFunction2() {} function exampleFunction (line 94) | function exampleFunction() {} function asyncFunction (line 96) | async function asyncFunction() {} class Iterable (line 98) | class Iterable { method [Symbol.iterator] (line 99) | *[Symbol.iterator](): Iterator { function predicate (line 107) | function predicate(c): c is ConstructorlessClass { function weirdCodeInDescription (line 115) | function weirdCodeInDescription() {} function spinxLinkInDescription (line 120) | function spinxLinkInDescription() {} class GetSetDocs (line 122) | class GetSetDocs { method a (line 129) | get a() { method b (line 136) | set b(x: number) {} class Base (line 139) | class Base { method f (line 141) | f() {} method a (line 143) | get a() { class Extension (line 148) | class Extension extends Base { method g (line 150) | g() {} FILE: tests/test_build_ts/source/docs/conf.py function ts_type_xref_formatter (line 17) | def ts_type_xref_formatter(config, xref: TypeXRef) -> str: FILE: tests/test_build_ts/source/module.ts function f (line 9) | async function f() {} function z (line 11) | function z(a: number, b: typeof q): number { class A (line 18) | class A { method f (line 19) | async f() {} method g (line 23) | g(a: number): number { method [Symbol.iterator] (line 21) | [Symbol.iterator]() {} class Z (line 36) | class Z { method constructor (line 38) | constructor(a: number, b: number) {} method z (line 40) | z() {} type I (line 53) | interface I {} type TestTypeAlias (line 64) | type TestTypeAlias = { a: T }; type TestTypeAlias2 (line 65) | type TestTypeAlias2 = { a: number }; type TestTypeAlias3 (line 71) | type TestTypeAlias3 = { a: number }; function functionWithTypeParam (line 86) | function functionWithTypeParam(z: Z): T { FILE: tests/test_build_ts/test_build_ts.py class TestTextBuilder (line 8) | class TestTextBuilder(SphinxBuildTestCase): method test_autoclass_constructor (line 11) | def test_autoclass_constructor(self): method test_autoclass_order (line 20) | def test_autoclass_order(self): method test_autoclass_star_order (line 30) | def test_autoclass_star_order(self): method test_abstract_extends_and_implements (line 40) | def test_abstract_extends_and_implements(self): method test_exported_from (line 68) | def test_exported_from(self): method test_constructorless_class (line 81) | def test_constructorless_class(self): method test_optional_members (line 88) | def test_optional_members(self): method test_deprecated (line 112) | def test_deprecated(self): method test_example (line 132) | def test_example(self): method test_async (line 150) | def test_async(self): method test_symbol (line 163) | def test_symbol(self): method test_predicate (line 178) | def test_predicate(self): method test_get_set (line 194) | def test_get_set(self): method test_inherited_docs (line 226) | def test_inherited_docs(self): method test_automodule (line 258) | def test_automodule(self): class TestHtmlBuilder (line 393) | class TestHtmlBuilder(SphinxBuildTestCase): method test_extends_links (line 399) | def test_extends_links(self): method test_implements_links (line 405) | def test_implements_links(self): method test_extends_type_param_links (line 411) | def test_extends_type_param_links(self): method test_xrefs (line 426) | def test_xrefs(self): method test_sphinx_link_in_description (line 451) | def test_sphinx_link_in_description(self): method test_sphinx_js_type_class (line 459) | def test_sphinx_js_type_class(self): method test_autosummary (line 465) | def test_autosummary(self): FILE: tests/test_build_xref_none/source/docs/conf.py function ts_type_xref_formatter (line 10) | def ts_type_xref_formatter(config, xref): FILE: tests/test_build_xref_none/test_build_xref_none.py function test_build_fails_with_invalid_role (line 17) | def test_build_fails_with_invalid_role(tmp_path: Path): FILE: tests/test_common_mark/source/code.js function foo (line 4) | function foo() {} FILE: tests/test_common_mark/source/docs/conf.py function setup (line 10) | def setup(app): FILE: tests/test_common_mark/test_common_mark.py class Tests (line 4) | class Tests(SphinxBuildTestCase): method test_build_success (line 5) | def test_build_success(self): FILE: tests/test_dot_dot_paths/source/code.js function bar (line 4) | function bar(node) {} FILE: tests/test_dot_dot_paths/test_dot_dot_paths.py class Tests (line 4) | class Tests(SphinxBuildTestCase): method test_dot_dot (line 5) | def test_dot_dot(self): FILE: tests/test_incremental.py function build (line 15) | def build(app): function do_test (line 49) | def do_test(app, extension="js"): function test_incremental_js (line 89) | def test_incremental_js(make_app, app_params): function test_incremental_ts (line 98) | def test_incremental_ts(make_app, app_params): FILE: tests/test_init.py function test_relative_path_root (line 7) | def test_relative_path_root(): FILE: tests/test_ir.py function test_default (line 23) | def test_default(): function test_missing_default (line 30) | def test_missing_default(): function attr_with (line 68) | def attr_with(**kwargs): function func_with (line 86) | def func_with(**kwargs): function test_ir_serialization (line 130) | def test_ir_serialization(x): FILE: tests/test_jsdoc_analysis/source/class.js class Foo (line 8) | class Foo { method constructor (line 15) | constructor(ho) {} method bar (line 20) | get bar() { method bar (line 23) | set bar(baz) { method secret (line 32) | secret() {} FILE: tests/test_jsdoc_analysis/source/function.js function foo (line 17) | function foo(bar, baz = 8) {} FILE: tests/test_jsdoc_analysis/test_jsdoc.py function test_doclet_full_path (line 14) | def test_doclet_full_path(): class TestFunction (line 33) | class TestFunction(JsDocTestCase): method test_top_level_and_function (line 36) | def test_top_level_and_function(self): class TestClass (line 98) | class TestClass(JsDocTestCase): method test_class (line 101) | def test_class(self): FILE: tests/test_parsers.py function test_escapes (line 4) | def test_escapes(): function test_relative_dirs (line 12) | def test_relative_dirs(): FILE: tests/test_paths.py function clear_node_modules_env (line 12) | def clear_node_modules_env(monkeypatch): function global_install (line 17) | def global_install(tmp_path_factory, monkeypatch): function no_local_install (line 27) | def no_local_install(tmp_path_factory): function local_install (line 37) | def local_install(no_local_install): function env_install (line 46) | def env_install(monkeypatch): function test_global (line 52) | def test_global(global_install, no_local_install): function test_node_modules1 (line 60) | def test_node_modules1(global_install, local_install): function test_node_modules2 (line 66) | def test_node_modules2(local_install): function test_env1 (line 72) | def test_env1(env_install): function test_env2 (line 77) | def test_env2(env_install, local_install, global_install): function test_err (line 85) | def test_err(): function test_global_install (line 94) | def test_global_install(tmp_path_factory, monkeypatch): FILE: tests/test_renderers.py function setindent (line 31) | def setindent(txt): function test_render_description (line 35) | def test_render_description(): function ts_xref_formatter (line 65) | def ts_xref_formatter(config, xref): function make_renderer (line 73) | def make_renderer(cls): function function_renderer (line 88) | def function_renderer(): function attribute_renderer (line 99) | def attribute_renderer(): function auto_module_renderer (line 104) | def auto_module_renderer(): function function_render (line 118) | def function_render(function_renderer) -> Any: function attribute_render (line 133) | def attribute_render(attribute_renderer) -> Any: function type_alias_render (line 145) | def type_alias_render(attribute_renderer) -> Any: function auto_module_render (line 157) | def auto_module_render(auto_module_renderer) -> Any: function make_class (line 222) | def make_class(**args): function make_interface (line 226) | def make_interface(**args): function make_function (line 230) | def make_function(**args): function make_attribute (line 234) | def make_attribute(**args): function make_type_alias (line 238) | def make_type_alias(**args): function make_module (line 242) | def make_module(**args): function test_func_render_simple (line 249) | def test_func_render_simple(function_render): function test_func_render_shortnames (line 253) | def test_func_render_shortnames(function_render): function test_func_render_flags (line 261) | def test_func_render_flags(function_render): function test_func_render_description (line 275) | def test_func_render_description(function_render): function test_func_render_params (line 285) | def test_func_render_params(function_render): function test_func_render_returns (line 313) | def test_func_render_returns(function_render): function test_func_render_type_params (line 329) | def test_func_render_type_params(function_render): function test_render_xref (line 350) | def test_render_xref(function_renderer: AutoFunctionRenderer): function test_func_render_param_type (line 390) | def test_func_render_param_type(function_render): function test_func_render_param_options (line 423) | def test_func_render_param_options(function_render): function test_func_render_param_exceptions (line 446) | def test_func_render_param_exceptions(function_render): function test_func_render_callouts (line 460) | def test_func_render_callouts(function_render): function test_all (line 485) | def test_all(function_render): function test_examples (line 517) | def test_examples(function_render): function test_type_alias (line 567) | def test_type_alias(type_alias_render): function test_auto_module_render (line 601) | def test_auto_module_render(auto_module_render): FILE: tests/test_suffix_tree.py function test_things (line 6) | def test_things(): function test_full_path (line 23) | def test_full_path(): function test_terminal_insertion (line 33) | def test_terminal_insertion(): function test_ambiguous_even_if_full_path (line 42) | def test_ambiguous_even_if_full_path(): function test_ambiguous_paths_reported (line 52) | def test_ambiguous_paths_reported(): function test_value_ambiguity (line 64) | def test_value_ambiguity(): FILE: tests/test_testing.py function test_dict_where (line 4) | def test_dict_where(): FILE: tests/test_typedoc_analysis/source/exports.ts type Blah (line 1) | interface Blah { FILE: tests/test_typedoc_analysis/source/nodes.ts class Superclass (line 1) | class Superclass { method method (line 2) | method() {} type SuperInterface (line 5) | interface SuperInterface {} type Interface (line 7) | interface Interface extends SuperInterface {} type InterfaceWithMembers (line 9) | interface InterfaceWithMembers { function func (line 29) | function func(a: number = 1, ...b: string[]): number { class ClassWithProperties (line 33) | class ClassWithProperties { method constructor (line 42) | constructor(a: number) {} method gettable (line 44) | get gettable(): number { method settable (line 48) | set settable(value: string) {} class Indexable (line 51) | class Indexable { type TestTypeAlias (line 62) | type TestTypeAlias = 1 | 2 | T; FILE: tests/test_typedoc_analysis/source/subdir/pathSegments.ts function foo (line 4) | function foo(): void { class Foo (line 15) | class Foo { method constructor (line 34) | constructor(num: number) { method someMethod (line 41) | someMethod(): void {} method staticMethod (line 46) | static staticMethod(): void {} method getter (line 51) | get getter(): number { method setter (line 58) | set setter(n: number) {} type Face (line 61) | interface Face { FILE: tests/test_typedoc_analysis/source/types.ts type Color (line 5) | enum Color { type Interface (line 28) | interface Interface { function interfacer (line 33) | function interfacer(a: Interface) {} type FunctionInterface (line 35) | interface FunctionInterface { function noThis (line 41) | function noThis(this: void) { function overload (line 48) | function overload(x): any {} type CertainNumbers (line 52) | type CertainNumbers = 1 | 2 | 4; type FooHaver (line 59) | interface FooHaver { type BarHaver (line 63) | interface BarHaver { function aryIdentity (line 71) | function aryIdentity(things: T[]): T[] { class GenericNumber (line 76) | class GenericNumber { type Lengthwise (line 82) | interface Lengthwise { function constrainedIdentity (line 89) | function constrainedIdentity(arg: T): T { function getProperty (line 97) | function getProperty(obj: T, key: K) { class A (line 101) | class A {} function create1 (line 103) | function create1(c: { new (x: number): A }): A { function create2 (line 107) | function create2(c: { new (): T }): T { class ParamClass (line 114) | class ParamClass { method constructor (line 115) | constructor() {} function objProps (line 133) | function objProps( function codeInDescription (line 150) | function codeInDescription() {} function destructureTest (line 160) | function destructureTest({ a, b }: { b: { c: string }; a: string }) {} function destructureTest2 (line 168) | function destructureTest2({ function destructureTest3 (line 185) | function destructureTest3({ a, b }: { a: string; b: { c: string } }) {} function destructureTest4 (line 190) | function destructureTest4(destructureThisPlease: { function funcArg (line 200) | function funcArg(a: (b: number, c: number) => number) {} function namedTupleArg (line 202) | function namedTupleArg(namedTuple: [key: string, value: any]) {} type PrivateTypeAlias1 (line 207) | type PrivateTypeAlias1 = { a: number; b: string }; type PrivateTypeAlias2 (line 213) | type PrivateTypeAlias2 = { a: number; b: string }; class HasHiddenTypeMember (line 224) | class HasHiddenTypeMember { type ConditionalType (line 236) | type ConditionalType = T extends A ? 1 : 2; type InferredType (line 238) | type InferredType = T extends Promise ? S : T; type keys (line 240) | type keys = "A" | "B" | "C"; type MappedType1 (line 242) | type MappedType1 = { [property in keys]: number }; type MappedType2 (line 243) | type MappedType2 = { -readonly [property in keys]?: number }; type MappedType3 (line 244) | type MappedType3 = { readonly [property in keys]-?: number }; type TemplateLiteral (line 246) | type TemplateLiteral = `${number}: ${string}`; type OptionalType (line 248) | type OptionalType = [number?]; type CustomTags (line 256) | type CustomTags = {}; FILE: tests/test_typedoc_analysis/test_typedoc_analysis.py function join_type (line 28) | def join_type(t: Type) -> str: function join_description (line 36) | def join_description(t: Description) -> str: class TestPathSegments (line 44) | class TestPathSegments(TypeDocTestCase): method commented_object (line 49) | def commented_object(self, comment, **kwargs): method commented_object_path (line 54) | def commented_object_path(self, comment, **kwargs): method test_class (line 61) | def test_class(self): method test_instance_property (line 69) | def test_instance_property(self): method test_static_property (line 78) | def test_static_property(self): method test_interface_property (line 87) | def test_interface_property(self): method test_weird_name (line 96) | def test_weird_name(self): method test_getter (line 107) | def test_getter(self): method test_setter (line 116) | def test_setter(self): method test_method (line 125) | def test_method(self): method test_static_method (line 134) | def test_static_method(self): method test_constructor (line 146) | def test_constructor(self): method test_function (line 160) | def test_function(self): method test_relative_paths (line 171) | def test_relative_paths(self): method test_namespaced_var (line 183) | def test_namespaced_var(self): class TestConvertNode (line 194) | class TestConvertNode(TypeDocAnalyzerTestCase): method test_class1 (line 200) | def test_class1(self): method test_interface (line 244) | def test_interface(self): method test_interface_function_member (line 257) | def test_interface_function_member(self): method test_variable (line 265) | def test_variable(self): method test_function (line 271) | def test_function(self): method test_constructor (line 305) | def test_constructor(self): method test_properties (line 316) | def test_properties(self): method test_getter (line 353) | def test_getter(self): method test_setter (line 360) | def test_setter(self): method test_type_alias (line 367) | def test_type_alias(self): class TestTypeName (line 375) | class TestTypeName(TypeDocAnalyzerTestCase): method test_basic (line 380) | def test_basic(self): method test_named_interface (line 403) | def test_named_interface(self): method test_interface_readonly_member (line 411) | def test_interface_readonly_member(self): method test_array (line 421) | def test_array(self): method test_literal_types (line 432) | def test_literal_types(self): method test_unions (line 443) | def test_unions(self): method test_intersection (line 455) | def test_intersection(self): method test_generic_function (line 464) | def test_generic_function(self): method test_generic_member (line 472) | def test_generic_member(self): method test_constrained_by_interface (line 484) | def test_constrained_by_interface(self): method test_constrained_by_key (line 499) | def test_constrained_by_key(self): method test_class_constrained (line 535) | def test_class_constrained(self): method test_constrained_by_constructor (line 556) | def test_constrained_by_constructor(self): method test_utility_types (line 566) | def test_utility_types(self): method test_internal_symbol_reference (line 586) | def test_internal_symbol_reference(self): method test_constrained_by_property (line 597) | def test_constrained_by_property(self): method test_optional_property (line 612) | def test_optional_property(self): method test_code_in_description (line 618) | def test_code_in_description(self): method test_destructured (line 632) | def test_destructured(self): method test_funcarg (line 664) | def test_funcarg(self): method test_namedtuplearg (line 670) | def test_namedtuplearg(self): method test_query (line 676) | def test_query(self): method test_type_operator (line 681) | def test_type_operator(self): method test_private_type_alias1 (line 686) | def test_private_type_alias1(self): method test_private_type_alias2 (line 691) | def test_private_type_alias2(self): method test_hidden_type_top_level (line 696) | def test_hidden_type_top_level(self): method test_hidden_type_member (line 702) | def test_hidden_type_member(self): method test_rest_type (line 710) | def test_rest_type(self): method test_indexed_access_type (line 715) | def test_indexed_access_type(self): method test_conditional_type (line 720) | def test_conditional_type(self): method test_inferred_type (line 725) | def test_inferred_type(self): method test_mapped_type (line 730) | def test_mapped_type(self): method test_template_literal (line 741) | def test_template_literal(self): method test_custom_tags (line 746) | def test_custom_tags(self): FILE: tests/testing.py class ThisDirTestCase (line 14) | class ThisDirTestCase: method this_dir (line 19) | def this_dir(cls): class SphinxBuildTestCase (line 26) | class SphinxBuildTestCase(ThisDirTestCase): method setup_class (line 35) | def setup_class(cls): method teardown_class (line 45) | def teardown_class(cls): method _file_contents (line 48) | def _file_contents(self, filename): method _file_contents_eq (line 56) | def _file_contents_eq(self, filename, expected_contents): class JsDocTestCase (line 64) | class JsDocTestCase(ThisDirTestCase): method setup_class (line 68) | def setup_class(cls): class TypeDocTestCase (line 77) | class TypeDocTestCase(ThisDirTestCase): method setup_class (line 81) | def setup_class(cls): class TypeDocAnalyzerTestCase (line 98) | class TypeDocAnalyzerTestCase(TypeDocTestCase): method setup_class (line 102) | def setup_class(cls): function dict_where (line 112) | def dict_where(json, already_seen=None, **kwargs):