Merge branch 'main' into end-to-end-tests

Author: pawamoy

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 1.1.2
+_commit: 1.1.4
 _src_path: gh:mkdocstrings/handler-template
 author_email: dev@pawamoy.fr
 author_fullname: Timothée Mazzucotelli

.github/ISSUE_TEMPLATE/bug_report.md .github/ISSUE_TEMPLATE/1-bug.md.github/ISSUE_TEMPLATE/bug_report.md renamed to .github/ISSUE_TEMPLATE/1-bug.md

@@ -53,7 +53,7 @@ PASTE TRACEBACK HERE
 python -m mkdocstrings_handlers.python.debug  # | xclip -selection clipboard
 ```
 
-PASTE OUTPUT HERE
+PASTE MARKDOWN OUTPUT HERE
 
 ### Additional context
 <!-- Add any other relevant context about the problem here,

.github/ISSUE_TEMPLATE/feature_request.md .github/ISSUE_TEMPLATE/2-feature.md.github/ISSUE_TEMPLATE/feature_request.md renamed to .github/ISSUE_TEMPLATE/2-feature.md

@@ -0,0 +1,16 @@
+---
+name: Documentation update
+about: Point at unclear, missing or outdated documentation.
+title: "docs: "
+labels: docs
+assignees: pawamoy
+---
+
+### Is something unclear, missing or outdated in our documentation?
+<!-- A clear and concise description of what the documentation issue is. Ex. I can't find an explanation on feature [...]. -->
+
+### Relevant code snippets
+<!-- If the documentation issue is related to code, please provide relevant code snippets. -->
+
+### Link to the relevant documentation section
+<!-- Add a link to the relevant section of our documentation, or any addition context. -->

.github/ISSUE_TEMPLATE/3-docs.md

@@ -0,0 +1,18 @@
+---
+name: Change request
+about: Suggest any other kind of change for this project.
+title: "change: "
+assignees: pawamoy
+---
+
+### Is your change request related to a problem? Please describe.
+<!-- A clear and concise description of what the problem is. -->
+
+### Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
+
+### Describe alternatives you've considered
+<!-- A clear and concise description of any alternative solutions you've considered. -->
+
+### Additional context
+<!-- Add any other context or screenshots about the change request here. -->

.github/ISSUE_TEMPLATE/4-change.md

@@ -5,6 +5,52 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [1.10.8](https://github.com/mkdocstrings/python/releases/tag/1.10.8) - 2024-08-14
+
+<small>[Compare with 1.10.7](https://github.com/mkdocstrings/python/compare/1.10.7...1.10.8)</small>
+
+### Build
+
+- Depend on Griffe 0.49 ([a87dcad](https://github.com/mkdocstrings/python/commit/a87dcad36065dc3171512e166ec632ee3e5b0a64) by Timothée Mazzucotelli).
+
+## [1.10.7](https://github.com/mkdocstrings/python/releases/tag/1.10.7) - 2024-07-25
+
+<small>[Compare with 1.10.6](https://github.com/mkdocstrings/python/compare/1.10.6...1.10.7)</small>
+
+### Packaging
+
+- Include tests and all relevant files for downstream packaging in source distribution
+
+## [1.10.6](https://github.com/mkdocstrings/python/releases/tag/1.10.6) - 2024-07-25
+
+<small>[Compare with 1.10.5](https://github.com/mkdocstrings/python/compare/1.10.5...1.10.6)</small>
+
+### Bug Fixes
+
+- Fix condition to display members (check all members, not just non-inherited ones) ([3d838a9](https://github.com/mkdocstrings/python/commit/3d838a96f77fa128cd6f2afa5ed0cb151ab225fd) by Timothée Mazzucotelli).
+
+### Code Refactoring
+
+- Update code for Griffe 0.48 (removing deprecation warnings) ([eff10cc](https://github.com/mkdocstrings/python/commit/eff10ccf0fa1b2e73df912048a15c2d6406a2c8b) by Timothée Mazzucotelli). [Issue-173](https://github.com/mkdocstrings/python/issues/173)
+
+## [1.10.5](https://github.com/mkdocstrings/python/releases/tag/1.10.5) - 2024-06-19
+
+<small>[Compare with 1.10.4](https://github.com/mkdocstrings/python/compare/1.10.4...1.10.5)</small>
+
+### Bug Fixes
+
+- Mix both previous checks for displaying objects: not imported or public ([587963b](https://github.com/mkdocstrings/python/commit/587963ba53f765c9d7eefbc2fb80bdbb11164850) by Timothée Mazzucotelli). [Issue-294](https://github.com/mkdocstrings/griffe/issues/294)
+
+## [1.10.4](https://github.com/mkdocstrings/python/releases/tag/1.10.4) - 2024-06-18
+
+<small>[Compare with 1.10.3](https://github.com/mkdocstrings/python/compare/1.10.3...1.10.4)</small>
+
+### Code Refactoring
+
+- Only filter out imported objects instead of non-public ones after applying filters ([e2f4b35](https://github.com/mkdocstrings/python/commit/e2f4b35d29eca6f68afbd2e728ef7542a2abc992) by Timothée Mazzucotelli). [Issue-mkdocstrings/griffe-294](https://github.com/mkdocstrings/griffe/issues/294)
+- Update code for Griffe 0.46 to avoid deprecation warnings ([321b407](https://github.com/mkdocstrings/python/commit/321b407eb95195c44f3cf34d780784e0d6751998) by Timothée Mazzucotelli).
+- Change `load_external_modules` default value to `None` to support new default mode in Griffe ([ae5896c](https://github.com/mkdocstrings/python/commit/ae5896c1604e9089162d0d63ec97a510a6bcef89) by Timothée Mazzucotelli).
+
 ## [1.10.3](https://github.com/mkdocstrings/python/releases/tag/1.10.3) - 2024-05-22
 
 <small>[Compare with 1.10.2](https://github.com/mkdocstrings/python/compare/1.10.2...1.10.3)</small>

CHANGELOG.md

@@ -36,13 +36,11 @@ Run `make help` to see all the available actions!
 
 ## Tasks
 
-This project uses [duty](https://github.com/pawamoy/duty) to run tasks.
-A Makefile is also provided. The Makefile will try to run certain tasks
-on multiple Python versions. If for some reason you don't want to run the task
-on multiple Python versions, you run the task directly with `make run duty TASK`.
-
-The Makefile detects if a virtual environment is activated,
-so `make` will work the same with the virtualenv activated or not.
+The entry-point to run commands and tasks is the `make` Python script,
+located in the `scripts` directory. Try running `make` to show the available commands and tasks.
+The *commands* do not need the Python dependencies to be installed,
+while the *tasks* do.
+The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
 
 If you work in VSCode, we provide
 [an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup)

CONTRIBUTING.md

@@ -12,3 +12,6 @@ filterwarnings =
   error
   # TODO: remove once pytest-xdist 4 is released
   ignore:.*rsyncdir:DeprecationWarning:xdist
+  # TODO: remove once Griffe releases v1
+  ignore:.*`get_logger`:DeprecationWarning:_griffe
+  ignore:.*`name`:DeprecationWarning:_griffe

config/pytest.ini

@@ -4,7 +4,7 @@ editables>=0.5
 # maintenance
 build>=1.2
 git-changelog>=2.5
-twine>=5.1; python_version < '3.13'
+twine>=5.0; python_version < '3.13'
 
 # ci
 duty>=1.4

devdeps.txt

@@ -2,17 +2,19 @@
 
 {% block announce %}
 
-    <a href="{{ 'insiders/#how-to-become-a-sponsor' | url }}"><strong>Sponsorship</strong></a>
-    is now available!
+    <strong>Fund this project</strong> through
+    <a href="{{ 'insiders/#how-to-become-a-sponsor' | url }}"><strong>sponsorship</strong></a>
     <span class="twemoji heart pulse">
       {% include ".icons/octicons/heart-fill-16.svg" %}
     </span> &mdash;
 
-  For updates follow <strong>@pawamoy</strong> on
+  Follow
+  <strong>@pawamoy</strong> on
   <a rel="me" href="https://fosstodon.org/@pawamoy">
     <span class="twemoji mastodon">
       {% include ".icons/fontawesome/brands/mastodon.svg" %}
     </span>
     <strong>Fosstodon</strong>
   </a>
+  for updates
 {% endblock %}