Cielquan commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

Reason seems to be: https://github.com/sphinx-doc/sphinx/issues/11662

Cielquan commented 1 year ago

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)")

rstcheck / rstcheck-core

Update tooling #60

Check List