Enable CI checkers #3160
Enable CI checkers #3160
Conversation
electrocucaracha
requested review from
walterkozlowski,
karinesevilla,
jgu17,
collivier,
rgstori,
xudan16 and
steelescotr
as code owners
|
@electrocucaracha we use jenkins to do that (see verification here). The issue is the main doc tox is far too permissive... |
electrocucaracha
force-pushed
the
add_ci_tools
branch
from
617a3db
to
bf83de4
Compare
There was a problem hiding this comment.
Thanks, I think we pretty match need something like this in all of the docs.
I've just blindly ran a tox -re docs on this branch and I got this error:
docs run-test: commands[0] | bash -c 'find /home/csatari/work/anuket/CNTT -not -path /home/csatari/work/anuket/CNTT/.tox/\* -name \*.rst -type f -print0 | xargs -0 rstcheck'
Traceback (most recent call last):
File "/home/csatari/work/anuket/CNTT/.tox/docs/bin/rstcheck", line 5, in <module>
from rstcheck._cli import main
File "/home/csatari/work/anuket/CNTT/.tox/docs/lib/python3.9/site-packages/rstcheck/_cli.py", line 7, in <module>
from rstcheck_core import _extras, config as config_mod, runner
File "/home/csatari/work/anuket/CNTT/.tox/docs/lib/python3.9/site-packages/rstcheck_core/config.py", line 10, in <module>
import pydantic
File "pydantic/__init__.py", line 2, in init pydantic.__init__
File "pydantic/dataclasses.py", line 52, in init pydantic.dataclasses
# +--- init= parameter
ImportError: cannot import name dataclass_transform
ERROR: InvocationError for command /usr/bin/bash -c 'find /home/csatari/work/anuket/CNTT -not -path /home/csatari/work/anuket/CNTT/.tox/\* -name \*.rst -type f -print0 | xargs -0 rstcheck' (exited with code 123)
Is this something in my environment or some more generic issue?
| Kubernetes | ||
| Lakelse | ||
| OpenStack | ||
| sexualized |
There was a problem hiding this comment.
I do not know what is the use of this file, but this word is a bit strange here. ..
There was a problem hiding this comment.
It's part of the code of conduct document
There was a problem hiding this comment.
That is clear. I just do not know if .worldlist.txt contains words what we would like to allow, like Baraque or words what we would like to avoid.
There was a problem hiding this comment.
Yes, that list contains the additional words not included in the standard English Aspell dictionary.
|
If the community asks to merge the duplicated PR fixing the same refs as here. This PR can be safely closed. |
PySpelling is a python module for spell checking. It consumes Aspell or Hunspell checking tools to catch misspelled words. This can be useful during the core review. Signed-off-by: Victor Morales <[email protected]>
This tool checks reStructuredText syntax helping to detect non-trivial documentation issues. Signed-off-by: Victor Morales <[email protected]>
Signed-off-by: Victor Morales <[email protected]>
electrocucaracha
force-pushed
the
add_ci_tools
branch
from
bf83de4
to
b361953
Compare
Maybe it's only in your environment, not sure if you have to upgrade your tox package version. |
There was a problem hiding this comment.
Because of RTD forcing the use of .readthedocs.yaml, we don't have another choice than splitting the git repository per stream. This PR must be applied on next RM's git repository and not here.
Everything is already ready on my own repositories but sadly I don't have the rights needed on anuket-project organization. Please give me them to complete the migration.
Be free to ask for any detail about the migration during a Weekly Technical meeting.
PySpelling and rstcheck are tools that can be useful to detect spelling and syntax issues in documentation. This PR enables them as part of the docs Tox environment.