search

RDFLib / rdflib

RDFLib is a Python library for working with RDF, a simple yet powerful language for representing information.
https://rdflib.readthedocs.org
BSD 3-Clause "New" or "Revised" License
2.15k stars 555 forks source link

build(deps-dev): bump sphinx-autodoc-typehints from 1.25.2 to 2.0.1 #2849

Closed dependabot[bot] closed 2 months ago

dependabot[bot] commented 2 months ago

Bumps sphinx-autodoc-typehints from 1.25.2 to 2.0.1.

Release notes

Sourced from sphinx-autodoc-typehints's releases.

2.0.1

What's Changed

New Contributors

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.0.0...2.0.1

2.0.0

What's Changed

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.3...2.0.0

1.25.3

What's Changed

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.2...1.25.3

Commits


Dependabot compatibility score

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 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)
ashleysommer commented 2 months ago

New docs generation error with the new version of sphinx autodoc.

Traceback (most recent call last):
    File "/home/runner/work/rdflib/rdflib/.tox/py39-docs/lib/python3.9/site-packages/sphinx/cmd/build.py", line 290, in build_main
      app.build(args.force_all, args.filenames)
    File "/home/runner/work/rdflib/rdflib/.tox/py39-docs/lib/python3.9/site-packages/sphinx/application.py", line 351, in build
      self.builder.build_update()
    File "/home/runner/work/rdflib/rdflib/.tox/py39-docs/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 290, in build_update
      self.build(to_build,
    File "/home/runner/work/rdflib/rdflib/.tox/py39-docs/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 360, in build
      self.write(docnames, list(updated_docnames), method)
    File "/home/runner/work/rdflib/rdflib/.tox/py39-docs/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 567, in write
      self._write_serial(sorted(docnames))
    File "/home/runner/work/rdflib/rdflib/.tox/py39-docs/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 577, in _write_serial
      self.write_doc(docname, doctree)
    File "/opt/hostedtoolcache/Python/3.9.19/x64/lib/python3.9/contextlib.py", line 126, in __exit__
      next(self.gen)
    File "/home/runner/work/rdflib/rdflib/.tox/py39-docs/lib/python3.9/site-packages/sphinx/util/logging.py", line 219, in pending_warnings
      memhandler.flushTo(logger)
    File "/home/runner/work/rdflib/rdflib/.tox/py39-docs/lib/python3.9/site-packages/sphinx/util/logging.py", line 184, in flushTo
      logger.handle(record)
    File "/opt/hostedtoolcache/Python/3.9.19/x64/lib/python3.9/logging/__init__.py", line 1599, in handle
      self.callHandlers(record)
    File "/opt/hostedtoolcache/Python/3.9.19/x64/lib/python3.9/logging/__init__.py", line 1661, in callHandlers
      hdlr.handle(record)
    File "/opt/hostedtoolcache/Python/3.9.19/x64/lib/python3.9/logging/__init__.py", line 948, in handle
      rv = self.filter(record)
    File "/opt/hostedtoolcache/Python/3.9.19/x64/lib/python3.9/logging/__init__.py", line 806, in filter
      result = f.filter(record)
    File "/home/runner/work/rdflib/rdflib/.tox/py39-docs/lib/python3.9/site-packages/sphinx/util/logging.py", line 424, in filter
      raise exc
  sphinx.errors.SphinxWarning: /home/runner/work/rdflib/rdflib/.tox/py39-docs/lib/python3.9/site-packages/rdflib/graph.py:docstring of rdflib.graph.ConjunctiveGraph.parse:27:py:obj reference target not found: ConjunctionGraph.default_context

  Warning, treated as error:
  /home/runner/work/rdflib/rdflib/.tox/py39-docs/lib/python3.9/site-packages/rdflib/graph.py:docstring of rdflib.graph.ConjunctiveGraph.parse:27:py:obj reference target not found: ConjunctionGraph.default_context

Looks like someone had a typo in our docstrings, ConjunctionGraph instead of ConjunctiveGraph. The new version of Sphinx Autodocs can detect that now.

ashleysommer commented 2 months ago

Fix pushed for the "ConjunctionGraph" typo in the docstring, re-running tests now.

ashleysommer commented 2 months ago

There are more changes required before this will pass. See #2852

ashleysommer commented 2 months ago

Note, this Dependabot PR is no longer required because the sphinx-autodocs-fixes PR https://github.com/RDFLib/rdflib/pull/2852 already includes the v2.0.1 update. I'll close this one.

dependabot[bot] commented 2 months ago

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.