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 tooling #60

Merged
merged 36 commits into from Sep 9, 2023
Merged

Update tooling #60

merged 36 commits into from Sep 9, 2023

Conversation

Cielquan
Copy link
Contributor

@Cielquan Cielquan commented Sep 3, 2023

Check List

Resolves: #

  • I added tests for the changed code.
  • I updated the documentation for the changed code.
  • I ran the full tox test suite locally, so the CI pipelines should be green.
  • I added the change to the CHANGELOG.md file.

@Cielquan
Copy link
Contributor Author

Cielquan commented Sep 9, 2023

Modules runner, checker and config are not being documented. The cause may have something to do with these warnings:

WARNING: autodoc: failed to import module 'checker' from module 'rstcheck_core'; the following exception was raised:
PyO3 modules may only be initialized once per interpreter process
WARNING: autodoc: failed to import module 'config' from module 'rstcheck_core'; the following exception was raised:
PyO3 modules may only be initialized once per interpreter process
WARNING: autodoc: failed to import module 'runner' from module 'rstcheck_core'; the following exception was raised:
PyO3 modules may only be initialized once per interpreter process

and these errors:

/home/runner/work/rstcheck-core/rstcheck-core/docstring of typing.Callable:3: WARNING: py:meth reference target not found: rstcheck_core.checker.CodeBlockChecker.create_checker
/home/runner/work/rstcheck-core/rstcheck-core/docs/source/usage/library.rst:12: WARNING: py:class reference target not found: rstcheck_core.runner.RstcheckMainRunner
/home/runner/work/rstcheck-core/rstcheck-core/docs/source/usage/library.rst:19: WARNING: py:func reference target not found: rstcheck_core.checker.check_file

@Cielquan
Copy link
Contributor Author

Cielquan commented Sep 9, 2023

Reason seems to be: sphinx-doc/sphinx#11662

@Cielquan
Copy link
Contributor Author

Cielquan commented Sep 9, 2023

The warning cannot be fixed atm:

WARNING: Failed guarded type import with ImportError("cannot import name 'AbstractSetIntStr' from 'pydantic._internal._utils' (/home/runner/work/rstcheck-core/rstcheck-core/.tox/docs/lib/python3.11/site-packages/pydantic/_internal/_utils.py)")

Related issue: tox-dev/sphinx-autodoc-typehints#375

@Cielquan Cielquan merged commit cf047e4 into main Sep 9, 2023
19 of 22 checks passed
@Cielquan Cielquan deleted the update-tooling branch September 9, 2023 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant