Skip to content

Commit 1ca1eba

Browse files
committed
Add intersphinx reference points to howto and tutorial doc sections.
1 parent 541f57c commit 1ca1eba

File tree

6 files changed

+33
-3
lines changed

6 files changed

+33
-3
lines changed

doc/source/changelog.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
Change Log
33
==========
44

5+
v2.2.4 (2025-03-17)
6+
===================
7+
8+
* Add intersphinx reference points to howto and tutorial doc sections.
9+
10+
511
v2.2.3 (2025-03-14)
612
===================
713

doc/source/howto.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
How To
55
======
66

7+
.. _howto_add_properties:
8+
79
Add Properties to an Enum
810
-------------------------
911

@@ -41,6 +43,7 @@ equivalent to:
4143
.. literalinclude:: ../../tests/examples/howto_metaclass.py
4244
:lines: 2-7
4345

46+
.. _howto_symmetric_properties:
4447

4548
Get Enums from their properties
4649
-------------------------------
@@ -107,6 +110,9 @@ the metaclass you must also inherit from :py:class:`~enum_properties.SymmetricMi
107110
.. literalinclude:: ../../tests/examples/howto_symmetric_metaclass.py
108111
:lines: 2-7
109112

113+
114+
.. _howto_symmetric_precedence:
115+
110116
Handle Symmetric Overloads
111117
--------------------------
112118

@@ -137,6 +143,8 @@ example to make name case insensitive we might:
137143
.. literalinclude:: ../../tests/examples/howto_symmetric_builtins.py
138144

139145

146+
.. _howto_symmetric_decorator:
147+
140148
Mark @properties as Symmetric
141149
-----------------------------
142150

@@ -146,6 +154,8 @@ in the Enum value tuple as symmetric. For example:
146154
.. literalinclude:: ../../tests/examples/howto_symmetric_decorator.py
147155

148156

157+
.. _howto_specialize_members:
158+
149159
Specializing Member Functions
150160
-----------------------------
151161

@@ -172,6 +182,8 @@ can share the same specialization.
172182
.. literalinclude:: ../../tests/examples/howto_specialized_list.py
173183

174184

185+
.. _howto_flags:
186+
175187
Flags
176188
-----
177189

@@ -204,6 +216,8 @@ are supported on flags. Boundary specifiers must be supplied as named arguments:
204216
.. literalinclude:: ../../tests/examples/howto_flag_boundaries.py
205217

206218

219+
.. _howto_nested_class_values:
220+
207221
Use Nested Classes as Enums
208222
---------------------------
209223

@@ -230,6 +244,8 @@ the position of ``label`` is important.
230244
.. literalinclude:: ../../tests/examples/howto_nested_classes_313.py
231245

232246

247+
.. _howto_dataclass_enums:
248+
233249
What about dataclass Enums?
234250
---------------------------
235251

@@ -266,6 +282,8 @@ enumeration for the following reasons:**
266282
.. literalinclude:: ../../tests/examples/howto_dataclass_integration.py
267283

268284

285+
.. _howto_hash_equivalency:
286+
269287
Define hash equivalent enums
270288
----------------------------
271289

@@ -283,6 +301,8 @@ be an rgb tuple:
283301

284302
.. literalinclude:: ../../tests/examples/howto_hash_equiv_def.py
285303

304+
.. _howto_legacy_api:
305+
286306
Use the legacy (1.x) API
287307
------------------------
288308

doc/source/tutorial.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Enumerations in Python can provide rich class based interfaces, well suited to m
88
real world examples are presented here that leverage enum properties to encapsulate more
99
information and get our enums to do more work.
1010

11+
.. _tutorial_address_route:
12+
1113
Address Route Type
1214
__________________
1315

@@ -35,6 +37,8 @@ persisted in a datastore by value. By specifying them directly instead of using
3537
reserve the ability to add additional route types in alphabetical order without accidentally
3638
invalidating any persisted data.
3739

40+
.. _tutorial_mapbox_style:
41+
3842
MapBox Style
3943
____________
4044

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "enum-properties"
7-
version = "2.2.3"
7+
version = "2.2.4"
88
description = "Add properties and method specializations to Python enumeration values with a simple declarative syntax."
99
requires-python = ">=3.8,<4.0"
1010
authors = [

src/enum_properties/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
from dataclasses import dataclass
2020
from functools import cached_property
2121

22-
VERSION = (2, 2, 3)
22+
VERSION = (2, 2, 4)
2323

2424
__title__ = "Enum Properties"
2525
__version__ = ".".join(str(i) for i in VERSION)

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)