Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pdoc requirement from ~=14.1 to ~=14.2 #61

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Dec 14, 2023

Updates the requirements on pdoc to permit the latest version.

Changelog

Sourced from pdoc's changelog.

2023-12-13: pdoc 14.2.0

  • pdoc now documents PyO3 or pybind11 submodules that are not picked up by Python's builtin pkgutil module. (#633, @​mhils)
  • pdoc now supports Python 3.12's type statements and has improved TypeAlias rendering. (#651, @​mhils)
  • Imports in a TYPE_CHECKING section that reference members defined in another module's TYPE_CHECKING section now work correctly. (#649, @​mhils)
  • Add support for code-block ReST directives (#624, @​JCGoran)
  • If a variable's value meets certain entropy criteria and matches an environment variable value, pdoc will now emit a warning and display the variable's name as a placeholder instead. This heuristic is meant to prevent accidental leakage of environment secrets and can be disabled by setting PDOC_DISPLAY_ENV_VARS=1. (#622, @​mhils)

2023-09-10: pdoc 14.1.0

  • Add compatibility with Python 3.12 (#620, @​mhils)
  • Add support for relative links. Instead of explicitly referring to mypackage.helpers.foo, one can now also refer to .helpers.foo within the mypackage module, or ..helpers.foo in a submodule. (#544, @​Crozzers)
  • Function signatures will now display "Foo" instead "demo.Foo" if the function is in the same module. (#544, @​mhils)
  • pdoc now also picks up docstrings from .pyi stub files. (#619, @​mhils)
  • Fix horizontal scroll navigation z-index issue. (#616, @​Domi04151309)
  • Be more strict about parsing URLs in pdoc's web server. (#617, @​mhils)

2023-06-19: pdoc 14.0.0

  • Functions, classes and variables can now be hidden from documentation by adding @private to their docstring. (#578, @​mhils)
  • pdoc can now be configured to skip classes/functions/variables without docstrings by passing --no-include-undocumented. (#578, @​mhils)
  • pdoc now documents variables by default, even if they have no docstring or type annotation. Please make yourself heard in #574 if that introduces significant issues for your use case. (#575, @​mhils)
  • Add support for Python 3.12. (#570, @​mhils)
  • Remove support for Python 3.7, which has reached end-of-life on 2023-06-27. (#569, @​mhils)

... (truncated)

Commits

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Updates the requirements on [pdoc](https://github.com/mitmproxy/pdoc) to permit the latest version.
- [Changelog](https://github.com/mitmproxy/pdoc/blob/main/CHANGELOG.md)
- [Commits](mitmproxy/pdoc@v14.1.0...v14.2.0)

---
updated-dependencies:
- dependency-name: pdoc
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Dec 14, 2023
Copy link
Contributor Author

dependabot bot commented on behalf of github Dec 25, 2023

Superseded by #66.

@dependabot dependabot bot closed this Dec 25, 2023
@dependabot dependabot bot deleted the dependabot/pip/pdoc-approx-eq-14.2 branch December 25, 2023 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants