From: Vladimír Vondruš Date: Thu, 18 Jul 2019 14:01:57 +0000 (+0200) Subject: documentation/python: move entry ID to the
element. X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=6c7df64dcdddf5a4348ca75da2ce7b41ec9f6995;p=blog.git documentation/python: move entry ID to the
element. Fancy new stuff incoming! --- diff --git a/documentation/templates/python/entry-data.html b/documentation/templates/python/entry-data.html index 25930b1a..e54faa2f 100644 --- a/documentation/templates/python/entry-data.html +++ b/documentation/templates/python/entry-data.html @@ -1,5 +1,5 @@ -
- {{ data.name }}{% if data.type %}: {{ data.type }}{% endif %}{% if data.value %} = {{ data.value }}{% endif %} + + {{ data.name }}{% if data.type %}: {{ data.type }}{% endif %}{% if data.value %} = {{ data.value }}{% endif %} {# This has to be here to avoid the newline being eaten #}
diff --git a/documentation/templates/python/entry-enum.html b/documentation/templates/python/entry-enum.html index e9620d64..22e54bc8 100644 --- a/documentation/templates/python/entry-enum.html +++ b/documentation/templates/python/entry-enum.html @@ -1,5 +1,5 @@ -
+ {% set j = joiner('\n ') %} - class {{ enum.name }}{% if enum.base %}({{ enum.base }}){% endif %}: {% for value in enum.values %}{{ j() }}{{ value.name }}{% if value.value is not none %} = {{ value.value }}{% endif %}{% endfor %} + class {{ enum.name }}{% if enum.base %}({{ enum.base }}){% endif %}: {% for value in enum.values %}{{ j() }}{{ value.name }}{% if value.value is not none %} = {{ value.value }}{% endif %}{% endfor %}
{{ enum.summary }}
diff --git a/documentation/templates/python/entry-function.html b/documentation/templates/python/entry-function.html index fc689ca3..2cd7c8b1 100644 --- a/documentation/templates/python/entry-function.html +++ b/documentation/templates/python/entry-function.html @@ -1,5 +1,5 @@ -
+ {% set j = joiner('\n ' if function.has_complex_params else ' ') %} - def {{ function.name }}({% for param in function.params %}{% if loop.index0 %}{% if function.params[loop.index0 - 1].kind == 'POSITIONAL_OR_KEYWORD' and param.kind == 'KEYWORD_ONLY' %}, *,{% else %},{% endif %}{% endif %}{{ j() }}{% if param.kind == 'VAR_POSITIONAL' %}*{% elif param.kind == 'VAR_KEYWORD' %}**{% endif %}{{ param.name }}{% if param.type %}: {{ param.type }}{% endif %}{% if param.default %} = {{ param.default }}{% endif %}{% if param.kind == 'POSITIONAL_ONLY' and (loop.last or function.params[loop.index0 + 1].kind != 'POSITIONAL_ONLY') %}, /{% endif %}{% endfor %}){% if function.type %} -> {{ function.type }}{% endif %} + def {{ function.name }}({% for param in function.params %}{% if loop.index0 %}{% if function.params[loop.index0 - 1].kind == 'POSITIONAL_OR_KEYWORD' and param.kind == 'KEYWORD_ONLY' %}, *,{% else %},{% endif %}{% endif %}{{ j() }}{% if param.kind == 'VAR_POSITIONAL' %}*{% elif param.kind == 'VAR_KEYWORD' %}**{% endif %}{{ param.name }}{% if param.type %}: {{ param.type }}{% endif %}{% if param.default %} = {{ param.default }}{% endif %}{% if param.kind == 'POSITIONAL_ONLY' and (loop.last or function.params[loop.index0 + 1].kind != 'POSITIONAL_ONLY') %}, /{% endif %}{% endfor %}){% if function.type %} -> {{ function.type }}{% endif %}
{{ function.summary }}
diff --git a/documentation/templates/python/entry-property.html b/documentation/templates/python/entry-property.html index ebaa1ea1..6da7ba3e 100644 --- a/documentation/templates/python/entry-property.html +++ b/documentation/templates/python/entry-property.html @@ -1,4 +1,4 @@ -
- {{ property.name }}{% if property.type %}: {{ property.type }}{% endif %} {% if property.is_gettable and property.is_settable %}get set{% elif property.is_gettable %}get{% else %}set{% endif %}{% if property.is_deletable %} del{% endif %} + + {{ property.name }}{% if property.type %}: {{ property.type }}{% endif %} {% if property.is_gettable and property.is_settable %}get set{% elif property.is_gettable %}get{% else %}set{% endif %}{% if property.is_deletable %} del{% endif %}
{{ property.summary }}
diff --git a/documentation/test_python/content/content.html b/documentation/test_python/content/content.html index 604bbad7..7797d68e 100644 --- a/documentation/test_python/content/content.html +++ b/documentation/test_python/content/content.html @@ -49,8 +49,8 @@ tho.

Data

-
- CONSTANT: float = 3.14 +
+ CONSTANT: float = 3.14
This is finally a docstring for content.CONSTANT
diff --git a/documentation/test_python/inspect_all_property/inspect_all_property.html b/documentation/test_python/inspect_all_property/inspect_all_property.html index 0e6a75de..ae97cb2d 100644 --- a/documentation/test_python/inspect_all_property/inspect_all_property.html +++ b/documentation/test_python/inspect_all_property/inspect_all_property.html @@ -60,8 +60,8 @@ YAY = 3
-
- class UndocumentedEnum(enum.IntFlag): FLAG_ONE = 1 +
+ class UndocumentedEnum(enum.IntFlag): FLAG_ONE = 1 FLAG_SEVENTEEN = 17
@@ -70,8 +70,8 @@

Functions

-
- def _private_but_exposed_func() +
+ def _private_but_exposed_func()
@@ -79,8 +79,8 @@

Data

-
- _private_data = 'Hey!' +
+ _private_data = 'Hey!'
diff --git a/documentation/test_python/inspect_annotations/inspect_annotations.Foo.html b/documentation/test_python/inspect_annotations/inspect_annotations.Foo.html index 6ee52928..1a2ad7b1 100644 --- a/documentation/test_python/inspect_annotations/inspect_annotations.Foo.html +++ b/documentation/test_python/inspect_annotations/inspect_annotations.Foo.html @@ -37,8 +37,8 @@

Properties

-
- a_property: typing.List[bool] get +
+ a_property: typing.List[bool] get
A property with a type annotation
diff --git a/documentation/test_python/inspect_annotations/inspect_annotations.FooSlots.html b/documentation/test_python/inspect_annotations/inspect_annotations.FooSlots.html index 6273b60b..47843142 100644 --- a/documentation/test_python/inspect_annotations/inspect_annotations.FooSlots.html +++ b/documentation/test_python/inspect_annotations/inspect_annotations.FooSlots.html @@ -37,12 +37,12 @@

Properties

-
- annotated: typing.List[str] get set del +
+ annotated: typing.List[str] get set del
-
- unannotated get set del +
+ unannotated get set del
diff --git a/documentation/test_python/inspect_annotations/inspect_annotations.html b/documentation/test_python/inspect_annotations/inspect_annotations.html index 50f2489c..bcdff17e 100644 --- a/documentation/test_python/inspect_annotations/inspect_annotations.html +++ b/documentation/test_python/inspect_annotations/inspect_annotations.html @@ -48,77 +48,77 @@

Functions

-
- def annotated_positional_keyword(bar = False, *, +
+ def annotated_positional_keyword(bar = False, *, foo: str, **kwargs)
Function with explicitly delimited keyword args and type annotations
-
- def annotation(param: typing.List[int], +
+ def annotation(param: typing.List[int], another: bool, third: str = 'hello') -> float
An annotated function
-
- def annotation_any(a: typing.Any) +
+ def annotation_any(a: typing.Any)
Annotation with the Any type
-
- def annotation_callable(a: typing.Callable[[float, int], str]) +
+ def annotation_callable(a: typing.Callable[[float, int], str])
Annotation with the Callable type
-
- def annotation_callable_no_args(a: typing.Callable[[], typing.Dict[int, float]]) +
+ def annotation_callable_no_args(a: typing.Callable[[], typing.Dict[int, float]])
Annotation with the Callable type w/o arguments
-
- def annotation_func_instead_of_type(a) +
+ def annotation_func_instead_of_type(a)
Annotation with a function instead of a type, ignored
-
- def annotation_generic(a: typing.List[Tp]) -> Tp +
+ def annotation_generic(a: typing.List[Tp]) -> Tp
Annotation with a generic type
-
- def annotation_list_noparam(a: typing.List[T]) +
+ def annotation_list_noparam(a: typing.List[T])
Annotation with the unparametrized List type. 3.7 adds an implicit TypeVar to it, 3.6 not, emulate that to make the test pass on older versions
-
- def annotation_optional(a: typing.Optional[float]) +
+ def annotation_optional(a: typing.Optional[float])
Annotation with the Optional type
-
- def annotation_tuple_instead_of_tuple(a) +
+ def annotation_tuple_instead_of_tuple(a)
Annotation with a tuple instead of Tuple, ignored
-
- def annotation_union(a: typing.Union[float, int]) +
+ def annotation_union(a: typing.Union[float, int])
Annotation with the Union type
-
- def args_kwargs(a, b, *args, **kwargs) +
+ def args_kwargs(a, b, *args, **kwargs)
Function with args and kwargs
-
- def no_annotation(a, b, z) +
+ def no_annotation(a, b, z)
Non-annotated function
-
- def no_annotation_default_param(param, +
+ def no_annotation_default_param(param, another, third = 'hello')
Non-annotated function with a default parameter
-
- def partial_annotation(foo, +
+ def partial_annotation(foo, param: typing.Tuple[int, int], unannotated, cls: object)
Partially annotated function
-
- def positional_keyword(positional_kw, *, kw_only) +
+ def positional_keyword(positional_kw, *, kw_only)
Function with explicitly delimited keyword args
@@ -126,12 +126,12 @@

Data

-
- ANNOTATED_VAR: typing.Tuple[bool, str] = (False, 'No.') +
+ ANNOTATED_VAR: typing.Tuple[bool, str] = (False, 'No.')
-
- UNANNOTATED_VAR = 3.45 +
+ UNANNOTATED_VAR = 3.45
diff --git a/documentation/test_python/inspect_annotations/math.html b/documentation/test_python/inspect_annotations/math.html index 57768b03..ebfe209d 100644 --- a/documentation/test_python/inspect_annotations/math.html +++ b/documentation/test_python/inspect_annotations/math.html @@ -38,12 +38,12 @@ mathematical functions defined by the C standard.

Functions

-
- def pow(x, y, /) +
+ def pow(x, y, /)
Return x**y (x to the power of y).
-
- def log(...) +
+ def log(...)
log(x, [base=math.e]) Return the logarithm of x to the given base.
diff --git a/documentation/test_python/inspect_annotations/math36.html b/documentation/test_python/inspect_annotations/math36.html index 0964811c..66f3dcd5 100644 --- a/documentation/test_python/inspect_annotations/math36.html +++ b/documentation/test_python/inspect_annotations/math36.html @@ -38,8 +38,8 @@ mathematical functions defined by the C standard.

Functions

-
- def log(...) +
+ def log(...)
log(x[, base])
diff --git a/documentation/test_python/inspect_name_mapping/inspect_name_mapping.Class.html b/documentation/test_python/inspect_name_mapping/inspect_name_mapping.Class.html index 381b567e..52145fbc 100644 --- a/documentation/test_python/inspect_name_mapping/inspect_name_mapping.Class.html +++ b/documentation/test_python/inspect_name_mapping/inspect_name_mapping.Class.html @@ -37,8 +37,8 @@

Methods

-
- def a_thing(self) -> Class +
+ def a_thing(self) -> Class
A method
diff --git a/documentation/test_python/inspect_name_mapping/inspect_name_mapping.html b/documentation/test_python/inspect_name_mapping/inspect_name_mapping.html index dd07e033..1253ae76 100644 --- a/documentation/test_python/inspect_name_mapping/inspect_name_mapping.html +++ b/documentation/test_python/inspect_name_mapping/inspect_name_mapping.html @@ -52,8 +52,8 @@

Functions

-
- def foo() -> Class +
+ def foo() -> Class
This function returns Class, *not* _sub.Foo
diff --git a/documentation/test_python/inspect_name_mapping/inspect_name_mapping.submodule.html b/documentation/test_python/inspect_name_mapping/inspect_name_mapping.submodule.html index 5c003407..1a731905 100644 --- a/documentation/test_python/inspect_name_mapping/inspect_name_mapping.submodule.html +++ b/documentation/test_python/inspect_name_mapping/inspect_name_mapping.submodule.html @@ -37,8 +37,8 @@

Functions

-
- def foo(a: Class, +
+ def foo(a: Class, b: int) -> int
A function
diff --git a/documentation/test_python/inspect_recursive/inspect_recursive.html b/documentation/test_python/inspect_recursive/inspect_recursive.html index a8668b61..ca8a143e 100644 --- a/documentation/test_python/inspect_recursive/inspect_recursive.html +++ b/documentation/test_python/inspect_recursive/inspect_recursive.html @@ -55,12 +55,12 @@

Functions

-
- def bar() -> Foo +
+ def bar() -> Foo
Function that also returns Foo
-
- def foo() -> Foo +
+ def foo() -> Foo
Function that returns Foo
diff --git a/documentation/test_python/inspect_string/inspect_string.DerivedException.html b/documentation/test_python/inspect_string/inspect_string.DerivedException.html index 6fff1668..e46b4a2f 100644 --- a/documentation/test_python/inspect_string/inspect_string.DerivedException.html +++ b/documentation/test_python/inspect_string/inspect_string.DerivedException.html @@ -51,8 +51,8 @@

Methods

-
- def with_traceback(...) +
+ def with_traceback(...)
Exception.with_traceback(tb) -- set self.__traceback__ to tb and return self.
@@ -61,12 +61,12 @@ set self.__traceback__ to tb and return self.

Special methods

-
- def __reduce__(...) +
+ def __reduce__(...)
-
- def __setstate__(...) +
+ def __setstate__(...)
@@ -74,8 +74,8 @@ set self.__traceback__ to tb and return self.

Properties

-
- args get +
+ args get
diff --git a/documentation/test_python/inspect_string/inspect_string.Foo.html b/documentation/test_python/inspect_string/inspect_string.Foo.html index a029bd11..0569310b 100644 --- a/documentation/test_python/inspect_string/inspect_string.Foo.html +++ b/documentation/test_python/inspect_string/inspect_string.Foo.html @@ -68,8 +68,8 @@ YAY = 2
Inner enum
-
- class UndocumentedInnerEnum(enum.IntFlag): FLAG_ONE = 1 +
+ class UndocumentedInnerEnum(enum.IntFlag): FLAG_ONE = 1 FLAG_SEVENTEEN = 17
@@ -78,8 +78,8 @@

Class methods

-
- def func_on_class(a) +
+ def func_on_class(a)
A class method
@@ -87,8 +87,8 @@

Static methods

-
- def static_func(a) +
+ def static_func(a)
A static method
@@ -96,8 +96,8 @@

Methods

-
- def func(self, a, b) +
+ def func(self, a, b)
A method
@@ -105,20 +105,20 @@

Properties

-
- a_property get +
+ a_property get
A property
-
- deletable_property get del +
+ deletable_property get del
Deletable property
-
- writable_property get set +
+ writable_property get set
Writable property
-
- writeonly_property set +
+ writeonly_property set
Write-only property
@@ -126,8 +126,8 @@

Data

-
- A_DATA = 'BOO' +
+ A_DATA = 'BOO'
diff --git a/documentation/test_python/inspect_string/inspect_string.FooSlots.html b/documentation/test_python/inspect_string/inspect_string.FooSlots.html index 02f30ee9..f40daa45 100644 --- a/documentation/test_python/inspect_string/inspect_string.FooSlots.html +++ b/documentation/test_python/inspect_string/inspect_string.FooSlots.html @@ -49,12 +49,12 @@

Properties

-
- first get set del +
+ first get set del
-
- second get set del +
+ second get set del
diff --git a/documentation/test_python/inspect_string/inspect_string.Specials.html b/documentation/test_python/inspect_string/inspect_string.Specials.html index c8e9c1bd..520570d4 100644 --- a/documentation/test_python/inspect_string/inspect_string.Specials.html +++ b/documentation/test_python/inspect_string/inspect_string.Specials.html @@ -49,16 +49,16 @@

Special methods

-
- def __add__(self, other) +
+ def __add__(self, other)
Add a thing
-
- def __and__(self, other) +
+ def __and__(self, other)
-
- def __init__(self) +
+ def __init__(self)
The constructor
diff --git a/documentation/test_python/inspect_string/inspect_string.html b/documentation/test_python/inspect_string/inspect_string.html index 1722ce7d..3bd5a79f 100644 --- a/documentation/test_python/inspect_string/inspect_string.html +++ b/documentation/test_python/inspect_string/inspect_string.html @@ -81,8 +81,8 @@ YAY = 2
An enum
-
- class UndocumentedEnum(enum.IntFlag): FLAG_ONE = 1 +
+ class UndocumentedEnum(enum.IntFlag): FLAG_ONE = 1 FLAG_SEVENTEEN = 17
@@ -91,8 +91,8 @@

Functions

-
- def function() +
+ def function()
A function
@@ -100,28 +100,28 @@

Data

-
- A_CONSTANT = 3.24 +
+ A_CONSTANT = 3.24
-
- A_FALSE_VALUE = False +
+ A_FALSE_VALUE = False
-
- A_NONE_VALUE = None +
+ A_NONE_VALUE = None
-
- A_ZERO_VALUE = 0 +
+ A_ZERO_VALUE = 0
-
- ENUM_THING = MyEnum.YAY +
+ ENUM_THING = MyEnum.YAY
-
- foo +
+ foo
diff --git a/documentation/test_python/inspect_type_links/inspect_type_links.first.Foo.Foo.html b/documentation/test_python/inspect_type_links/inspect_type_links.first.Foo.Foo.html index 3c7eb461..129c8253 100644 --- a/documentation/test_python/inspect_type_links/inspect_type_links.first.Foo.Foo.html +++ b/documentation/test_python/inspect_type_links/inspect_type_links.first.Foo.Foo.html @@ -37,13 +37,13 @@

Methods

-
- def reference_parent(self, +
+ def reference_parent(self, a: first.Foo)
A method referencing its parent wrapper class
-
- def reference_self(self, +
+ def reference_self(self, a: Foo)
A method referencing its wrapper class
diff --git a/documentation/test_python/inspect_type_links/inspect_type_links.first.Foo.html b/documentation/test_python/inspect_type_links/inspect_type_links.first.Foo.html index 1fb3539b..aac4c36e 100644 --- a/documentation/test_python/inspect_type_links/inspect_type_links.first.Foo.html +++ b/documentation/test_python/inspect_type_links/inspect_type_links.first.Foo.html @@ -45,23 +45,23 @@

Methods

-
- def reference_inner(self, +
+ def reference_inner(self, a: Foo)
A method referencing an inner class. This is quite a pathological case and I'm not sure if Foo or Foo.Foo is better.
-
- def reference_other(self, +
+ def reference_other(self, a: second.Foo)
A method referencing a type in another module
-
- def reference_self(self, +
+ def reference_self(self, a: first.Foo)
A method referencing its wrapper class. Due to the inner Foo this is quite a pathological case and I'm not sure if first.Foo or Foo is better.
-
- def reference_sub(self, +
+ def reference_sub(self, a: sub.Foo, b: sub.Foo)
diff --git a/documentation/test_python/inspect_type_links/inspect_type_links.first.html b/documentation/test_python/inspect_type_links/inspect_type_links.first.html index 535daf39..39bf563f 100644 --- a/documentation/test_python/inspect_type_links/inspect_type_links.first.html +++ b/documentation/test_python/inspect_type_links/inspect_type_links.first.html @@ -53,17 +53,17 @@

Functions

-
- def reference_other(a: second.Foo) +
+ def reference_other(a: second.Foo)
A function referencing a type in another module
-
- def reference_self(a: Foo, +
+ def reference_self(a: Foo, b: Foo)
A function referencing a type in this module
-
- def reference_sub(a: sub.Foo, +
+ def reference_sub(a: sub.Foo, b: sub.Foo)
A function referencing a type in a submodule
diff --git a/documentation/test_python/inspect_type_links/inspect_type_links.first.sub.Foo.html b/documentation/test_python/inspect_type_links/inspect_type_links.first.sub.Foo.html index b70351aa..43f9dfcd 100644 --- a/documentation/test_python/inspect_type_links/inspect_type_links.first.sub.Foo.html +++ b/documentation/test_python/inspect_type_links/inspect_type_links.first.sub.Foo.html @@ -37,13 +37,13 @@

Methods

-
- def reference_parent(a: first.Foo, +
+ def reference_parent(a: first.Foo, b: first.Foo)
A method referencing a type in a parent module
-
- def reference_self(a: Foo) +
+ def reference_self(a: Foo)
A method referencing a type in this submodule
diff --git a/documentation/test_python/inspect_type_links/inspect_type_links.first.sub.html b/documentation/test_python/inspect_type_links/inspect_type_links.first.sub.html index 94ca8c67..9d9303dc 100644 --- a/documentation/test_python/inspect_type_links/inspect_type_links.first.sub.html +++ b/documentation/test_python/inspect_type_links/inspect_type_links.first.sub.html @@ -45,13 +45,13 @@

Functions

-
- def reference_parent(a: first.Foo, +
+ def reference_parent(a: first.Foo, b: first.Foo)
A function referencing a type in a parent module
-
- def reference_self(a: Foo, +
+ def reference_self(a: Foo, b: Foo)
A function referencing a type in this submodule
diff --git a/documentation/test_python/inspect_type_links/inspect_type_links.second.Foo.html b/documentation/test_python/inspect_type_links/inspect_type_links.second.Foo.html index 33ea06d9..7629eb46 100644 --- a/documentation/test_python/inspect_type_links/inspect_type_links.second.Foo.html +++ b/documentation/test_python/inspect_type_links/inspect_type_links.second.Foo.html @@ -38,28 +38,28 @@

Properties

-
- type_property: Enum get +
+ type_property: Enum get
A property
-
- type_property_string_invalid: FooBar get +
+ type_property_string_invalid: FooBar get
A property
-
- type_property_string_nested: typing.Tuple[Foo, typing.List[Enum], typing.Any] get +
+ type_property_string_nested: typing.Tuple[Foo, typing.List[Enum], typing.Any] get
A property
-
- type_property_writeonly: Enum set +
+ type_property_writeonly: Enum set
A writeonly property
-
- type_property_writeonly_string_invalid: Foo.Bar set +
+ type_property_writeonly_string_invalid: Foo.Bar set
A writeonly property with invalid string type
-
- type_property_writeonly_string_nested: typing.Tuple[Foo, typing.List[Enum], typing.Any] set +
+ type_property_writeonly_string_nested: typing.Tuple[Foo, typing.List[Enum], typing.Any] set
A writeonly property with a string nested type
@@ -67,8 +67,8 @@

Data

-
- TYPE_DATA_STRING_INVALID: Foo.Bar = 3 +
+ TYPE_DATA_STRING_INVALID: Foo.Bar = 3
diff --git a/documentation/test_python/inspect_type_links/inspect_type_links.second.FooSlots.html b/documentation/test_python/inspect_type_links/inspect_type_links.second.FooSlots.html index 1c79b018..0899d4cd 100644 --- a/documentation/test_python/inspect_type_links/inspect_type_links.second.FooSlots.html +++ b/documentation/test_python/inspect_type_links/inspect_type_links.second.FooSlots.html @@ -37,12 +37,12 @@

Properties

-
- type_slot: Enum get set del +
+ type_slot: Enum get set del
-
- type_slot_string_nested: typing.Tuple[Foo, typing.List[Enum], typing.Any] get set del +
+ type_slot_string_nested: typing.Tuple[Foo, typing.List[Enum], typing.Any] get set del
diff --git a/documentation/test_python/inspect_type_links/inspect_type_links.second.FooSlotsInvalid.html b/documentation/test_python/inspect_type_links/inspect_type_links.second.FooSlotsInvalid.html index 73b24346..0ee0df12 100644 --- a/documentation/test_python/inspect_type_links/inspect_type_links.second.FooSlotsInvalid.html +++ b/documentation/test_python/inspect_type_links/inspect_type_links.second.FooSlotsInvalid.html @@ -37,8 +37,8 @@

Properties

-
- type_slot_string_invalid: typing.List[FooBar] get set del +
+ type_slot_string_invalid: typing.List[FooBar] get set del
diff --git a/documentation/test_python/inspect_type_links/inspect_type_links.second.html b/documentation/test_python/inspect_type_links/inspect_type_links.second.html index 368458f3..44eda51a 100644 --- a/documentation/test_python/inspect_type_links/inspect_type_links.second.html +++ b/documentation/test_python/inspect_type_links/inspect_type_links.second.html @@ -51,8 +51,8 @@

Enums

-
- class Enum(enum.Enum): FIRST = 1 +
+ class Enum(enum.Enum): FIRST = 1 SECOND = 2
An enum
@@ -61,54 +61,54 @@

Functions

-
- def type_cant_link(a: inspect_type_links.second._Hidden) +
Annotation linking to a type that's a part of INPUT_MODULES but not known
-
- def type_default_values(a: Enum = Enum.SECOND, +
+ def type_default_values(a: Enum = Enum.SECOND, b: typing.Tuple[Foo] = (<class 'inspect_type_links.second.Foo'>,), c: Foo = …)
A function with default values, one enum, one tuple and the third nonrepresentable (yes, the tuple looks ugly)
-
- def type_enum(a: Enum) +
+ def type_enum(a: Enum)
Function referencing an enum
-
- def type_nested(a: typing.Tuple[Foo, typing.List[Enum], typing.Any]) +
+ def type_nested(a: typing.Tuple[Foo, typing.List[Enum], typing.Any])
A function with nested type annotation
-
- def type_nested_string(a: typing.Tuple[Foo, typing.List[Enum], typing.Any]) +
+ def type_nested_string(a: typing.Tuple[Foo, typing.List[Enum], typing.Any])
A function with nested string type annotation
-
- def type_nested_string_invalid(a: typing.Tuple[FooBar, List[Enum], Any]) +
+ def type_nested_string_invalid(a: typing.Tuple[FooBar, List[Enum], Any])
A function with invalid nested string type annotation
-
- def type_return() -> Foo +
+ def type_return() -> Foo
A function with a return type annotation
-
- def type_return_string_invalid(a: Foo) -> FooBar +
+ def type_return_string_invalid(a: Foo) -> FooBar
A function with invalid return string type annotation
-
- def type_return_string_nested() -> typing.Tuple[Foo, typing.List[Enum], typing.Any] +
+ def type_return_string_nested() -> typing.Tuple[Foo, typing.List[Enum], typing.Any]
A function with a string nested return type
-
- def type_string(a: Foo) +
+ def type_string(a: Foo)
A function with string type annotation
-
- def type_string_invalid(a: Foo.Bar) +
+ def type_string_invalid(a: Foo.Bar)
A function with invalid string type annotation
-
- def type_string_nested(a: typing.Tuple[Foo, typing.List[Enum], typing.Any]) +
+ def type_string_nested(a: typing.Tuple[Foo, typing.List[Enum], typing.Any])
A function with string nested type annotation
@@ -116,16 +116,16 @@

Data

-
- TYPE_DATA: Foo +
+ TYPE_DATA: Foo
-
- TYPE_DATA_ENUM: Enum = Enum.SECOND +
+ TYPE_DATA_ENUM: Enum = Enum.SECOND
-
- TYPE_DATA_STRING_NESTED: typing.Tuple[Foo, typing.List[Enum], typing.Any] = {} +
+ TYPE_DATA_STRING_NESTED: typing.Tuple[Foo, typing.List[Enum], typing.Any] = {}
diff --git a/documentation/test_python/link_formatting/c.link_formatting.Class.html b/documentation/test_python/link_formatting/c.link_formatting.Class.html index 2fb12127..54167493 100644 --- a/documentation/test_python/link_formatting/c.link_formatting.Class.html +++ b/documentation/test_python/link_formatting/c.link_formatting.Class.html @@ -63,8 +63,8 @@

Properties

-
- property: Enum get +
+ property: Enum get
A property.
diff --git a/documentation/test_python/link_formatting/c.link_formatting.pybind.Foo.html b/documentation/test_python/link_formatting/c.link_formatting.pybind.Foo.html index 945727df..77b0a748 100644 --- a/documentation/test_python/link_formatting/c.link_formatting.pybind.Foo.html +++ b/documentation/test_python/link_formatting/c.link_formatting.pybind.Foo.html @@ -56,8 +56,8 @@

Static methods

-
- def a_function(arg0: int, /) -> int +
+ def a_function(arg0: int, /) -> int
A static function that should have the same hash as takes_int()
@@ -65,13 +65,13 @@

Methods

-
- def bar(self, +
+ def bar(self, arg0: int, /) -> int
Should have the same hash as foo() but not as a_function()
-
- def foo(self, +
+ def foo(self, arg0: int, /) -> int
Should have the same hash as bar() but not as a_function()
diff --git a/documentation/test_python/link_formatting/m.link_formatting.html b/documentation/test_python/link_formatting/m.link_formatting.html index 03ad9ab1..74d5aeb4 100644 --- a/documentation/test_python/link_formatting/m.link_formatting.html +++ b/documentation/test_python/link_formatting/m.link_formatting.html @@ -75,8 +75,8 @@

Enums

-
- class Enum(enum.Enum): FIRST_VALUE = 1 +
+ class Enum(enum.Enum): FIRST_VALUE = 1 SECOND_VALUE = 2
An enum
@@ -85,8 +85,8 @@

Functions

-
- def function(a: Enum = Enum.SECOND_VALUE) -> Class +
+ def function(a: Enum = Enum.SECOND_VALUE) -> Class
A function.
@@ -94,8 +94,8 @@

Data

-
- SOME_DATA: Enum = Enum.FIRST_VALUE +
+ SOME_DATA: Enum = Enum.FIRST_VALUE
diff --git a/documentation/test_python/link_formatting/m.link_formatting.pybind.html b/documentation/test_python/link_formatting/m.link_formatting.pybind.html index 214996a7..7f47d9d2 100644 --- a/documentation/test_python/link_formatting/m.link_formatting.pybind.html +++ b/documentation/test_python/link_formatting/m.link_formatting.pybind.html @@ -63,22 +63,22 @@

Functions

-
- def an_overloaded_function(arg0: int, +
+ def an_overloaded_function(arg0: int, arg1: float, /) -> int
Each overload should have a different hash
-
- def an_overloaded_function(arg0: int, /) -> int +
+ def an_overloaded_function(arg0: int, /) -> int
Each overload should have a different hash
-
- def an_overloaded_function(arg0: int, +
+ def an_overloaded_function(arg0: int, arg1: Foo, /) -> int
Each overload should have a different hash
-
- def takes_int(arg0: int, /) -> int +
+ def takes_int(arg0: int, /) -> int
Should have the same hash as Foo.a_function()
diff --git a/documentation/test_python/pybind_enums/pybind_enums.html b/documentation/test_python/pybind_enums/pybind_enums.html index 797aa907..e776b896 100644 --- a/documentation/test_python/pybind_enums/pybind_enums.html +++ b/documentation/test_python/pybind_enums/pybind_enums.html @@ -26,15 +26,15 @@

Enums

-
- class MyEnum: First = 0 +
+ class MyEnum: First = 0 Second = 1 Third = 74 CONSISTANTE = -5
An enum without value docs :(
-
- class SixtyfourBitFlag: Yes = 1000000000000 +
+ class SixtyfourBitFlag: Yes = 1000000000000 No = 18446744073709551615
64-bit flags
diff --git a/documentation/test_python/pybind_name_mapping/pybind_name_mapping.Class.html b/documentation/test_python/pybind_name_mapping/pybind_name_mapping.Class.html index b65fa10f..94c16d83 100644 --- a/documentation/test_python/pybind_name_mapping/pybind_name_mapping.Class.html +++ b/documentation/test_python/pybind_name_mapping/pybind_name_mapping.Class.html @@ -37,8 +37,8 @@

Static methods

-
- def a_thing() -> Class +
+ def a_thing() -> Class
A method
diff --git a/documentation/test_python/pybind_name_mapping/pybind_name_mapping.html b/documentation/test_python/pybind_name_mapping/pybind_name_mapping.html index 8f3df052..d1d90b5e 100644 --- a/documentation/test_python/pybind_name_mapping/pybind_name_mapping.html +++ b/documentation/test_python/pybind_name_mapping/pybind_name_mapping.html @@ -52,8 +52,8 @@

Functions

-
- def foo() -> Class +
+ def foo() -> Class
This function returns Class, *not* _sub.Foo
diff --git a/documentation/test_python/pybind_name_mapping/pybind_name_mapping.submodule.html b/documentation/test_python/pybind_name_mapping/pybind_name_mapping.submodule.html index ce8dd513..58683c8e 100644 --- a/documentation/test_python/pybind_name_mapping/pybind_name_mapping.submodule.html +++ b/documentation/test_python/pybind_name_mapping/pybind_name_mapping.submodule.html @@ -37,8 +37,8 @@

Functions

-
- def foo(arg0: Class, +
+ def foo(arg0: Class, arg1: int, /) -> int
A function
diff --git a/documentation/test_python/pybind_signatures/pybind_signatures.MyClass.html b/documentation/test_python/pybind_signatures/pybind_signatures.MyClass.html index 08fe68c2..e62b1f2e 100644 --- a/documentation/test_python/pybind_signatures/pybind_signatures.MyClass.html +++ b/documentation/test_python/pybind_signatures/pybind_signatures.MyClass.html @@ -40,8 +40,8 @@

Static methods

-
- def static_function(arg0: int, +
+ def static_function(arg0: int, arg1: float, /) -> MyClass
Static method with positional-only args
@@ -50,18 +50,18 @@

Methods

-
- def another(self, /) -> int +
+ def another(self, /) -> int
Instance method with no args, 'self' is thus position-only
-
- def instance_function(self, +
+ def instance_function(self, arg0: int, arg1: str, /) -> Tuple[float, int]
Instance method with positional-only args
-
- def instance_function_kwargs(self, +
+ def instance_function_kwargs(self, hey: int, what: str = '<eh?>') -> Tuple[float, int]
@@ -71,8 +71,8 @@

Special methods

-
- def __init__(self, /) +
+ def __init__(self, /)
Constructor
@@ -80,12 +80,12 @@

Properties

-
- bar: float get +
+ bar: float get
A read-only property
-
- foo: float get set +
+ foo: float get set
A read/write property
diff --git a/documentation/test_python/pybind_signatures/pybind_signatures.MyClass23.html b/documentation/test_python/pybind_signatures/pybind_signatures.MyClass23.html index 4bb551e2..54354af6 100644 --- a/documentation/test_python/pybind_signatures/pybind_signatures.MyClass23.html +++ b/documentation/test_python/pybind_signatures/pybind_signatures.MyClass23.html @@ -38,12 +38,12 @@

Properties

-
- writeonly: float set +
+ writeonly: float set
A write-only property
-
- writeonly_crazy set +
+ writeonly_crazy set
A write-only property with a type that can't be parsed
@@ -51,8 +51,8 @@

Data

-
- is_pybind23 = True +
+ is_pybind23 = True
diff --git a/documentation/test_python/pybind_signatures/pybind_signatures.html b/documentation/test_python/pybind_signatures/pybind_signatures.html index 32f91e2a..c557155d 100644 --- a/documentation/test_python/pybind_signatures/pybind_signatures.html +++ b/documentation/test_python/pybind_signatures/pybind_signatures.html @@ -47,92 +47,92 @@

Functions

-
- def crazy_signature(…) +
+ def crazy_signature(…)
Function that failed to get parsed
-
- def duck(*args, **kwargs) +
+ def duck(*args, **kwargs)
A function taking args/kwargs directly
-
- def overloaded(arg0: int, /) -> str +
+ def overloaded(arg0: int, /) -> str
Overloaded for ints
-
- def overloaded(arg0: float, /) -> bool +
+ def overloaded(arg0: float, /) -> bool
Overloaded for floats
-
- def scale(arg0: int, +
+ def scale(arg0: int, arg1: float, /) -> int
Scale an integer
-
- def scale_kwargs(a: int, +
+ def scale_kwargs(a: int, argument: float) -> int
Scale an integer, kwargs
-
- def takes_a_function(arg0: Callable[[float, List[float]], int], /) +
+ def takes_a_function(arg0: Callable[[float, List[float]], int], /)
A function taking a Callable
-
- def taking_a_list_returning_a_tuple(arg0: List[float], /) -> Tuple[int, int, int] +
+ def taking_a_list_returning_a_tuple(arg0: List[float], /) -> Tuple[int, int, int]
Takes a list, returns a tuple
-
- def tenOverloads(arg0: float, +
+ def tenOverloads(arg0: float, arg1: float, /)
Ten overloads of a function
-
- def tenOverloads(arg0: int, +
+ def tenOverloads(arg0: int, arg1: float, /)
Ten overloads of a function
-
- def tenOverloads(arg0: bool, +
+ def tenOverloads(arg0: bool, arg1: float, /)
Ten overloads of a function
-
- def tenOverloads(arg0: float, +
+ def tenOverloads(arg0: float, arg1: int, /)
Ten overloads of a function
-
- def tenOverloads(arg0: int, +
+ def tenOverloads(arg0: int, arg1: int, /)
Ten overloads of a function
-
- def tenOverloads(arg0: bool, +
+ def tenOverloads(arg0: bool, arg1: int, /)
Ten overloads of a function
-
- def tenOverloads(arg0: float, +
+ def tenOverloads(arg0: float, arg1: bool, /)
Ten overloads of a function
-
- def tenOverloads(arg0: int, +
+ def tenOverloads(arg0: int, arg1: bool, /)
Ten overloads of a function
-
- def tenOverloads(arg0: bool, +
+ def tenOverloads(arg0: bool, arg1: bool, /)
Ten overloads of a function
-
- def tenOverloads(arg0: str, +
+ def tenOverloads(arg0: str, arg1: str, /)
Ten overloads of a function
-
- def void_function(arg0: int, /) +
+ def void_function(arg0: int, /)
Returns nothing
diff --git a/documentation/test_python/pybind_type_links/pybind_type_links.Foo.html b/documentation/test_python/pybind_type_links/pybind_type_links.Foo.html index 424c5bcc..636ed1eb 100644 --- a/documentation/test_python/pybind_type_links/pybind_type_links.Foo.html +++ b/documentation/test_python/pybind_type_links/pybind_type_links.Foo.html @@ -39,8 +39,8 @@

Special methods

-
- def __init__(self, +
+ def __init__(self, arg0: Enum, /)
Constructor
@@ -49,8 +49,8 @@

Properties

-
- property: Enum get set +
+ property: Enum get set
A property
@@ -58,8 +58,8 @@

Data

-
- TYPE_DATA: Enum = Enum.SECOND +
+ TYPE_DATA: Enum = Enum.SECOND
diff --git a/documentation/test_python/pybind_type_links/pybind_type_links.html b/documentation/test_python/pybind_type_links/pybind_type_links.html index b15e23bb..c3dd014b 100644 --- a/documentation/test_python/pybind_type_links/pybind_type_links.html +++ b/documentation/test_python/pybind_type_links/pybind_type_links.html @@ -47,8 +47,8 @@

Enums

-
- class Enum: FIRST = 0 +
+ class Enum: FIRST = 0 SECOND = 1
An enum
@@ -57,16 +57,16 @@

Functions

-
- def type_enum(value: Enum = Enum.SECOND) +
+ def type_enum(value: Enum = Enum.SECOND)
A function taking an enum
-
- def type_nested(arg0: Tuple[Foo, List[Enum]], /) +
+ def type_nested(arg0: Tuple[Foo, List[Enum]], /)
A function with nested type annotation
-
- def type_return() -> Foo +
+ def type_return() -> Foo
A function returning a type
@@ -74,8 +74,8 @@

Data

-
- TYPE_DATA: Foo +
+ TYPE_DATA: Foo