Merge branch 'main' into feature/add-import-warning

Author: arwedus

.github/workflows/main.yml

@@ -9,15 +9,15 @@ jobs:
     strategy:
       matrix:
         # Keep this in sync with tox.ini
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true

.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.x"
     - name: Install pypa/build
@@ -22,7 +22,7 @@ jobs:
     - name: Build a binary wheel and a source tarball
       run: python3 -m build
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
@@ -42,7 +42,7 @@ jobs:
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
@@ -63,12 +63,12 @@ jobs:
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
     - name: Sign the dists with Sigstore
-      uses: sigstore/gh-action-sigstore-python@v1.2.3
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
       with:
         inputs: >-
           ./dist/*.tar.gz
@@ -82,4 +82,4 @@ jobs:
       run: >-
         gh release upload
         '${{ github.ref_name }}' dist/**
-        --repo '${{ github.repository }}'
+        --repo '${{ github.repository }}'

.readthedocs.yml

@@ -5,6 +5,8 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
+  apt_packages:
+    - graphviz
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
@@ -23,4 +25,4 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - docs
+        - docs

CHANGELOG.rst

@@ -5,6 +5,157 @@ Versions follow `Semantic Versioning <https://semver.org/>`_ (``<major>.<minor>.
 
 .. towncrier release notes start
 
+v3.3.3 (2024-10-25)
+-------------------
+
+Bugfixes
+^^^^^^^^
+
+- Document packages and modules under a single "submodules" heading (#450)
+- Fix crash when __init__ is assigned to (#488)
+- Fix documenting incorrect attributes from __init__ (#497)
+
+
+Misc
+^^^^
+
+- #426, #462, #491, #492
+
+
+v3.3.2 (2024-09-25)
+-------------------
+
+Bugfixes
+^^^^^^^^
+
+- Fix types missing from documentation generated by autodoc-style directives. (#473)
+
+
+v3.3.1 (2024-09-01)
+-------------------
+
+Bugfixes
+^^^^^^^^
+
+- Fix all class members missing when documenting a module with the same name as a standard library module
+
+  Members inherited from the standard library can also have their skip value
+  overridden by autoapi-skip-member. (#478)
+
+
+Misc
+^^^^
+
+- Updated all github actions.
+
+
+v3.3.0 (2024-08-28)
+-------------------
+
+Features
+^^^^^^^^
+
+- Do not document members inherited from standard library classes. (#467)
+
+
+Bugfixes
+^^^^^^^^
+
+- Fix instance attributes not being documented by inherited-members (#477)
+
+
+Misc
+^^^^
+
+- #425
+- Fix the parser returning a dictionary instead of a list in the empty parse scenario
+- Rename testenvs to all follow similar naming style
+
+
+v3.2.1 (2024-07-23)
+-------------------
+
+Bugfixes
+^^^^^^^^
+
+- Fix error or duplicates when __init__ assigns to a property (#466)
+
+
+v3.2.0 (2024-07-20)
+-------------------
+
+Features
+^^^^^^^^
+
+- functools.cached_property is considered a property (#436)
+
+
+Bugfixes
+^^^^^^^^
+
+- Gracefully handle no objects being rendered (#448)
+- Fix ignoring undocumented instance attributes (#451)
+
+
+Deprecations and Removals
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- Removed ability for autoapi_template_dir to be relative to cwd. This was supposed to have been retired in v3 (#457)
+- Removed autoapi_include_summaries option. This was supposed to have been retired in v3
+
+
+Misc
+^^^^
+
+- #428, #449
+
+
+v3.1.2 (2024-06-20)
+-------------------
+
+Bugfixes
+^^^^^^^^
+
+- Fix imported members being rendered in modules (#452)
+
+
+v3.1.1 (2024-05-22)
+-------------------
+
+Bugfixes
+^^^^^^^^
+
+- Fix private subpackages causing orphan pages (#446)
+
+
+v3.1.0 (2024-05-20)
+-------------------
+
+Features
+^^^^^^^^
+
+- Objects can render to their own page (#226)
+- Render PEP-695 type aliases as TypeAlias assignments. (#414)
+
+
+Bugfixes
+^^^^^^^^
+
+- Values are always rendered for TypeAlises and PEP-695 type aliases. (#224)
+- Fix submodule with `__init__.pyi` documented as `__init__` instead of submodule name (#398)
+- Fix IndexError when a module docstring contains only a heading (#412)
+- Preserve strings inside Literal type annotations (#423)
+- Stopped using xrefs in page titles (#427)
+- Fix unpickable configuration value warning when using autoapi_prepare_jinja_env (#445)
+- Fix emitting ignore event twice for methods.
+
+
+Misc
+^^^^
+
+- #388
+
+
 v3.0.0 (2023-09-26)
 -------------------
 

README.rst

@@ -83,7 +83,7 @@ You can check your formatting using black's check mode:
 
 .. code-block:: bash
 
-    tox -e formatting
+    tox -e format
 
 You can also get black to format your changes for you:
 

autoapi/__init__.py

@@ -3,5 +3,5 @@
 from .extension import setup
 
 __all__ = ("setup",)
-__version__ = "3.0.0"
-__version_info__ = (3, 0, 0)
+__version__ = "3.3.3"
+__version_info__ = (3, 3, 3)