Skip to content

Commit 339d4cc

Browse files
authored
update doc links + frontpage (#216)
* update doc links + frontpage * update HISTORY.rst
1 parent 89fea20 commit 339d4cc

File tree

14 files changed

+64
-55
lines changed

14 files changed

+64
-55
lines changed

HISTORY.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
1-
=======
1+
`=======
22
History
33
=======
44

55

6+
0.36.2 (2025-12-15)
7+
------------------
8+
9+
**Documentation**
10+
11+
- Updated the documentation URL to ``https://dcw.ritviknag.com``.
12+
- Simplified the docs landing page by removing the redundant title header.
13+
- Refined the front-page layout for improved clarity and mobile readability.
14+
15+
**Notes**
16+
17+
- This release includes documentation and presentation updates only.
18+
- No functional or behavioral changes were introduced.
19+
620
0.36.1 (2025-12-15)
721
------------------
822

@@ -265,7 +279,7 @@ Happy Thanksgiving 🦃, y'all! In this release, Dataclass Wizard introduces the
265279

266280
* Fixed compatibility between `Global Meta Settings`_ and :attr:`recursive_classes` (:issue:`142`).
267281

268-
.. _Global Meta Settings: https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/meta.html#global-meta-settings
282+
.. _Global Meta Settings: https://dcw.ritviknag.com/en/latest/common_use_cases/meta.html#global-meta-settings
269283

270284
0.29.2 (2024-11-24)
271285
-------------------
@@ -593,7 +607,7 @@ Happy Thanksgiving 🦃, y'all! In this release, Dataclass Wizard introduces the
593607
* Update the docs and readme with examples and usage of *future
594608
annotations* in Python 3.7+.
595609

596-
.. _new-style annotations: https://dataclass-wizard.readthedocs.io/en/latest/python_compatibility.html#python-3-7
610+
.. _new-style annotations: https://dcw.ritviknag.com/en/latest/python_compatibility.html#python-3-7
597611
.. _PEP 585: https://www.python.org/dev/peps/pep-0585/
598612
.. _PEP 604: https://www.python.org/dev/peps/pep-0604/
599613

README.rst

Lines changed: 31 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
================
2-
Dataclass Wizard
3-
================
41

52
.. image:: https://raw.githubusercontent.com/rnag/dataclass-wizard/main/images/logo.png
63
:alt: Dataclass Wizard logo
@@ -9,7 +6,7 @@ Dataclass Wizard
96

107
**Simple, elegant wizarding tools for Python’s** ``dataclasses``.
118

12-
📘 Docs → `dataclass-wizard.ritviknag.com`_
9+
📘 Docs → `dcw.ritviknag.com`_
1310

1411
.. image:: https://github.com/rnag/dataclass-wizard/actions/workflows/dev.yml/badge.svg
1512
:target: https://github.com/rnag/dataclass-wizard/actions/workflows/dev.yml
@@ -27,9 +24,7 @@ Dataclass Wizard
2724
:target: https://pepy.tech/project/dataclass-wizard
2825
:alt: Downloads per Month
2926

30-
Lightning-fast ⚡, pure Python, and lightweight — Dataclass Wizard makes it easy
31-
to convert dataclass instances to and from JSON, with built-in support for
32-
complex dataclass models.
27+
**Dataclass Wizard** is a fast, well-tested serialization library for Python dataclasses.
3328

3429
-------------------
3530

@@ -161,7 +156,7 @@ of *Dataclass Wizard* for unsupported Python versions (3.6 – 3.8):
161156
.. _PyPI: https://pypi.org/project/dataclass-wizard/
162157
.. _conda: https://anaconda.org/conda-forge/dataclass-wizard
163158
.. _conda-forge: https://conda-forge.org/
164-
.. _Changelog: https://dataclass-wizard.ritviknag.com/en/latest/history.html
159+
.. _Changelog: https://dcw.ritviknag.com/en/latest/history.html
165160

166161
See the package on `PyPI`_ and the `Changelog`_ in the docs for the latest version details.
167162

@@ -377,7 +372,7 @@ debugging purposes. Whenever you invoke ``print(obj)`` or ``str(obj)``, for
377372
example, it'll call this method which will format the dataclass object as
378373
a prettified JSON string. If you prefer a ``__str__`` method to not be
379374
added, you can pass in ``str=False`` when extending from the Mixin class
380-
as mentioned `here <https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/skip_the_str.html>`_.
375+
as mentioned `here <https://dcw.ritviknag.com/en/latest/common_use_cases/skip_the_str.html>`_.
381376

382377
Note that the ``__repr__`` method, which is implemented by the
383378
``dataclass`` decorator, is also available. To invoke the Python object
@@ -1277,7 +1272,7 @@ Quick Examples
12771272

12781273
Combine these helpers for flexible serialization rules!
12791274

1280-
.. _conditional skipping: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/serialization_options.html#skip-if-functionality
1275+
.. _conditional skipping: https://dcw.ritviknag.com/en/latest/common_use_cases/serialization_options.html#skip-if-functionality
12811276

12821277
Serialization Options
12831278
---------------------
@@ -1426,7 +1421,7 @@ Easily map environment variables to Python dataclasses with ``EnvWizard``:
14261421
- **Configurable**: Customize variable names, prefixes, and dotenv files.
14271422
- **Validation**: Errors for missing or malformed variables.
14281423

1429-
📖 `Full Documentation <https://dataclass-wizard.ritviknag.com/en/latest/env_magic.html>`_
1424+
📖 `Full Documentation <https://dcw.ritviknag.com/en/latest/env_magic.html>`_
14301425

14311426
Advanced Example: Dynamic Prefix Handling
14321427
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1592,42 +1587,42 @@ Credits
15921587

15931588
This package was created with Cookiecutter_ and the `rnag/cookiecutter-pypackage`_ project template.
15941589

1595-
.. _dataclass-wizard.ritviknag.com: https://dataclass-wizard.ritviknag.com
1590+
.. _dcw.ritviknag.com: https://dcw.ritviknag.com
15961591
.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
15971592
.. _`rnag/cookiecutter-pypackage`: https://github.com/rnag/cookiecutter-pypackage
1598-
.. _`Contributing`: https://dataclass-wizard.ritviknag.com/en/latest/contributing.html
1593+
.. _`Contributing`: https://dcw.ritviknag.com/en/latest/contributing.html
15991594
.. _`open an issue`: https://github.com/rnag/dataclass-wizard/issues
1600-
.. _`JSONPyWizard`: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonpywizard
1601-
.. _`EnvWizard`: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#envwizard
1602-
.. _`on EnvWizard`: https://dataclass-wizard.ritviknag.com/en/latest/env_magic.html
1603-
.. _`JSONListWizard`: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonlistwizard
1604-
.. _`JSONFileWizard`: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonfilewizard
1605-
.. _`TOMLWizard`: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#tomlwizard
1606-
.. _`YAMLWizard`: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#yamlwizard
1607-
.. _`Container`: https://dataclass-wizard.ritviknag.com/en/latest/dataclass_wizard.html#dataclass_wizard.Container
1608-
.. _`Supported Types`: https://dataclass-wizard.ritviknag.com/en/latest/overview.html#supported-types
1595+
.. _`JSONPyWizard`: https://dcw.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonpywizard
1596+
.. _`EnvWizard`: https://dcw.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#envwizard
1597+
.. _`on EnvWizard`: https://dcw.ritviknag.com/en/latest/env_magic.html
1598+
.. _`JSONListWizard`: https://dcw.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonlistwizard
1599+
.. _`JSONFileWizard`: https://dcw.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#jsonfilewizard
1600+
.. _`TOMLWizard`: https://dcw.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#tomlwizard
1601+
.. _`YAMLWizard`: https://dcw.ritviknag.com/en/latest/common_use_cases/wizard_mixins.html#yamlwizard
1602+
.. _`Container`: https://dcw.ritviknag.com/en/latest/dataclass_wizard.html#dataclass_wizard.Container
1603+
.. _`Supported Types`: https://dcw.ritviknag.com/en/latest/overview.html#supported-types
16091604
.. _`Mixin`: https://stackoverflow.com/a/547714/10237506
1610-
.. _`Meta`: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/meta.html
1605+
.. _`Meta`: https://dcw.ritviknag.com/en/latest/common_use_cases/meta.html
16111606
.. _`pydantic`: https://pydantic-docs.helpmanual.io/
1612-
.. _`Using Field Properties`: https://dataclass-wizard.ritviknag.com/en/latest/using_field_properties.html
1613-
.. _`field properties`: https://dataclass-wizard.ritviknag.com/en/latest/using_field_properties.html
1614-
.. _`custom mapping`: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/custom_key_mappings.html
1615-
.. _`wiz-cli`: https://dataclass-wizard.ritviknag.com/en/latest/wiz_cli.html
1607+
.. _`Using Field Properties`: https://dcw.ritviknag.com/en/latest/using_field_properties.html
1608+
.. _`field properties`: https://dcw.ritviknag.com/en/latest/using_field_properties.html
1609+
.. _`custom mapping`: https://dcw.ritviknag.com/en/latest/common_use_cases/custom_key_mappings.html
1610+
.. _`wiz-cli`: https://dcw.ritviknag.com/en/latest/wiz_cli.html
16161611
.. _`key limitations`: https://florimond.dev/en/posts/2018/10/reconciling-dataclasses-and-properties-in-python/
1617-
.. _`more complete example`: https://dataclass-wizard.ritviknag.com/en/latest/examples.html#a-more-complete-example
1612+
.. _`more complete example`: https://dcw.ritviknag.com/en/latest/examples.html#a-more-complete-example
16181613
.. _custom formats: https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes
1619-
.. _`Patterned Date and Time`: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/patterned_date_time.html
1614+
.. _`Patterned Date and Time`: https://dcw.ritviknag.com/en/latest/common_use_cases/patterned_date_time.html
16201615
.. _Union: https://docs.python.org/3/library/typing.html#typing.Union
1621-
.. _`Dataclasses in Union Types`: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/dataclasses_in_union_types.html
1622-
.. _`Cyclic or "Recursive" Dataclasses`: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/cyclic_or_recursive_dataclasses.html
1616+
.. _`Dataclasses in Union Types`: https://dcw.ritviknag.com/en/latest/common_use_cases/dataclasses_in_union_types.html
1617+
.. _`Cyclic or "Recursive" Dataclasses`: https://dcw.ritviknag.com/en/latest/common_use_cases/cyclic_or_recursive_dataclasses.html
16231618
.. _as milestones: https://github.com/rnag/dataclass-wizard/milestones
16241619
.. _longstanding issue: https://github.com/rnag/dataclass-wizard/issues/62
1625-
.. _Easier Debug Mode: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/easier_debug_mode.html
1626-
.. _Handling Unknown JSON Keys: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/handling_unknown_json_keys.html
1627-
.. _custom paths to access nested keys: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/nested_key_paths.html
1620+
.. _Easier Debug Mode: https://dcw.ritviknag.com/en/latest/common_use_cases/easier_debug_mode.html
1621+
.. _Handling Unknown JSON Keys: https://dcw.ritviknag.com/en/latest/common_use_cases/handling_unknown_json_keys.html
1622+
.. _custom paths to access nested keys: https://dcw.ritviknag.com/en/latest/common_use_cases/nested_key_paths.html
16281623
.. _annotations: https://docs.python.org/3/library/typing.html#typing.Annotated
16291624
.. _typing: https://docs.python.org/3/library/typing.html
16301625
.. _dataclasses: https://docs.python.org/3/library/dataclasses.html
1631-
.. _V1 Opt-in documentation for Patterned Date and Time: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/v1_patterned_date_time.html
1626+
.. _V1 Opt-in documentation for Patterned Date and Time: https://dcw.ritviknag.com/en/latest/common_use_cases/v1_patterned_date_time.html
16321627
.. _`Field Guide to V1 Opt-in`: https://github.com/rnag/dataclass-wizard/wiki/Field-Guide-to-V1-Opt%E2%80%90in
1633-
.. _V1 Alias: https://dataclass-wizard.ritviknag.com/en/latest/common_use_cases/v1_alias.html
1628+
.. _V1 Alias: https://dcw.ritviknag.com/en/latest/common_use_cases/v1_alias.html

dataclass_wizard/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
>>> # {"myStr": "string", "listOfInt": [], "myDt": "2010-12-10T15:55:30Z"}
6363
6464
For full documentation and more advanced usage, please see
65-
<https://dataclass-wizard.readthedocs.io>.
65+
<https://dcw.ritviknag.com>.
6666
6767
:copyright: (c) 2021-2025 by Ritvik Nag.
6868
:license: Apache 2.0, see LICENSE for more details.

dataclass_wizard/bases_meta.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ def LoadMeta(**kwargs) -> META:
323323
>>> LoadMeta(key_transform='CAMEL').bind_to(MyClass)
324324
>>> fromdict(MyClass, {"myStr": "value"})
325325
326-
.. _Docs: https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/meta.html
326+
.. _Docs: https://dcw.ritviknag.com/en/latest/common_use_cases/meta.html
327327
"""
328328
base_dict = kwargs | {'__slots__': ()}
329329

@@ -357,7 +357,7 @@ def DumpMeta(**kwargs) -> META:
357357
>>> DumpMeta(key_transform='CAMEL').bind_to(MyClass)
358358
>>> asdict(MyClass, {"myStr": "value"})
359359
360-
.. _Docs: https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/meta.html
360+
.. _Docs: https://dcw.ritviknag.com/en/latest/common_use_cases/meta.html
361361
"""
362362

363363
# Set meta attributes here.
@@ -390,7 +390,7 @@ def EnvMeta(**kwargs) -> META:
390390
391391
>>> EnvMeta(key_transform_with_dump='SNAKE').bind_to(MyClass)
392392
393-
.. _Docs: https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/meta.html
393+
.. _Docs: https://dcw.ritviknag.com/en/latest/common_use_cases/meta.html
394394
"""
395395

396396
# Set meta attributes here.

dataclass_wizard/property_wizard.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def property_wizard(*args, **kwargs):
4242
the docs. I also added `an answer`_ on a SO article that deals with using
4343
such properties in dataclasses.
4444
45-
.. _Using Field Properties: https://dataclass-wizard.readthedocs.io/en/latest/using_field_properties.html
45+
.. _Using Field Properties: https://dcw.ritviknag.com/en/latest/using_field_properties.html
4646
.. _an answer: https://stackoverflow.com/a/68488125/10237506
4747
"""
4848
cls: Type = type(*args, **kwargs)

dataclass_wizard/v1/dumpers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ def dump_from_union(cls, tp: TypeInfo, extras: Extras):
419419
# ' * `v1_unsafe_parse_dataclass_in_union = True`\n'
420420
# f' - Set on class `{extras["cls_name"]}`\n\n'
421421
# 'For more information, refer to:\n'
422-
# ' https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/dataclasses_in_union_types.html')
422+
# ' https://dcw.ritviknag.com/en/latest/common_use_cases/dataclasses_in_union_types.html')
423423
# raise e from None
424424

425425
string = cls.get_string_for_annotation(tp_new, extras)

dataclass_wizard/v1/enums.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class KeyAction(Enum):
1717
- `WARN`: Log a warning for each unknown key.
1818
1919
For capturing unknown keys (e.g., including them in a dataclass), use the `CatchAll` field.
20-
More details: https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/handling_unknown_json_keys.html#capturing-unknown-keys-with-catchall
20+
More details: https://dcw.ritviknag.com/en/latest/common_use_cases/handling_unknown_json_keys.html#capturing-unknown-keys-with-catchall
2121
"""
2222
IGNORE = 0 # Silently skip unknown keys.
2323
RAISE = 1 # Raise an exception for the first unknown key.

dataclass_wizard/v1/loaders.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ def load_to_union(cls, tp: TypeInfo, extras: Extras):
468468
' * `v1_unsafe_parse_dataclass_in_union = True`\n'
469469
f' - Set on class `{extras["cls_name"]}`\n\n'
470470
'For more information, refer to:\n'
471-
' https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/dataclasses_in_union_types.html')
471+
' https://dcw.ritviknag.com/en/latest/common_use_cases/dataclasses_in_union_types.html')
472472
raise e from None
473473

474474
string = cls.get_string_for_annotation(tp_new, extras)

docs/common_use_cases/custom_key_mappings.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Map a JSON Key to a Field
99
This change is part of the ongoing improvements in version ``v0.35.0+``, and the old functionality will no longer be maintained in future releases.
1010

1111
.. _Field Guide to V1 Opt‐in: https://github.com/rnag/dataclass-wizard/wiki/Field-Guide-to-V1-Opt%E2%80%90in
12-
.. _V1 Alias: https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/v1_alias.html
12+
.. _V1 Alias: https://dcw.ritviknag.com/en/latest/common_use_cases/v1_alias.html
1313

1414
The ``dataclass-wizard`` library provides a set of built-in *key transform* helper
1515
functions that automatically transform the casing of keys in a JSON or Python

docs/common_use_cases/nested_key_paths.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Map a Nested JSON Key Path to a Field
99
This change is part of the ongoing improvements in version ``v0.35.0+``, and the old functionality will no longer be maintained in future releases.
1010

1111
.. _Field Guide to V1 Opt‐in: https://github.com/rnag/dataclass-wizard/wiki/Field-Guide-to-V1-Opt%E2%80%90in
12-
.. _V1 Alias: https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/v1_alias.html
12+
.. _V1 Alias: https://dcw.ritviknag.com/en/latest/common_use_cases/v1_alias.html
1313

1414
The ``dataclass-wizard`` library allows mapping deeply nested JSON paths to individual dataclass fields using a custom object path notation. This feature supports both :type:`Annotated` types and :class:`dataclasses.Field` for flexible and precise JSON deserialization.
1515

0 commit comments

Comments
 (0)