CHANGELOG.md

Changes in autodoc-traits

1.2

1.2.2 - 2024-04-17

(full changelog)

Maintenance and upkeep improvements

• Remove no longer needed upper bound pin on traitlets #64 (@consideRatio)

Continuous integration improvements

• build(deps): bump actions/setup-python from 4 to 5 #61 (@consideRatio)
• build(deps): bump actions/checkout from 3 to 4 #57 (@consideRatio)

1.2.1 - 2023-09-27

(full changelog)

Maintenance and upkeep improvements

• Bound traitlets<5.10 and add test for issue observed in newer versions #54 (@consideRatio, @manics)

1.2.0 - 2023-09-08

1.2.0 fixes compatibility with sphinx 7.2 and increases the minimum required sphinx version from 2 to 4.

(full changelog)

Bugs fixed

• sphinx 7.2 compatibility, require sphinx 4 #52 (@minrk, @manics, @consideRatio)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@consideRatio (activity) | @manics (activity) | @minrk (activity)

1.1

1.1.0 - 2022-12-20

(full changelog)

Enhancements made

• Automatically register the sphinx.ext.autodoc extension #18 (@consideRatio)

Bugs fixed

• register traits with a help string as documented for autoclass #33 (@minrk)
• avoid putting c.Class.trait annotation on non-config traits #32 (@minrk)
• Add tests, add docstrings, and fix small bugs #28 (@consideRatio)

Maintenance and upkeep improvements

• Add tests, add docstrings, and fix small bugs #28 (@consideRatio)
• single file module #25 (@minrk)
• maint: refactor __init__.py and add _version.py, drop setup.py, require python 3.7+ #21 (@consideRatio)

Documentation improvements

• Add tests, add docstrings, and fix small bugs #28 (@consideRatio)
• docs: add fixme note about unexpected inherited-members option #16 (@consideRatio)

Continuous integration improvements

• Bump pypa/gh-action-pypi-publish from 1.4.1 to 1.6.4 #23 (@dependabot)
• ci: add dependabot.yaml and update release workflow #20 (@consideRatio)

Contributors to this release

(GitHub contributors page for this release)

@consideRatio | @minrk

1.0

1.0.0 - 2022-12-06

Let's call it 1.0!

(full changelog)

Bugs fixed

• Fix failure to use autoclass on non-traitlets configurable classes #10 (@blink1073, @consideRatio)

Maintenance and upkeep improvements

• pre-commit: add typical jupyterhub org config #15 (@consideRatio, @minrk)

Documentation improvements

• Refresh README, RELEASE, and CHANGELOG #14 (@consideRatio, @minrk)
• Point url to the GitHub repo #8 (@yuvipanda, @consideRatio)
• add changelog.md, release.md, README badges #7 (@minrk, @yuvipanda, @consideRatio)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @consideRatio | @minrk | @willingc | @yuvipanda

0.1

0.1.0 - 2021-10-22

0.1.0 is the first stable release of autodoc-traits. It fixes compatibility with sphinx 4 from the previously published 0.1.0dev prerelease.

Merged PRs

• add publish github action #4 (@minrk)
• Remove unused import of deprecated PyClassmember #3 (@minrk)
• Remove duplicates in documenting trait members #1 (@rkdarst)

Contributors to this release

(GitHub contributors page for this release)

@betatim | @minrk | @rkdarst | @welcome | @willingc