Skip to content

Commit 0fc5616

Browse files
authored
Update docs tools (#461)
1 parent cab79c9 commit 0fc5616

File tree

4 files changed

+10
-16
lines changed

4 files changed

+10
-16
lines changed

.config/constraints.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
argparse-manpage==4.6 # via ansible-compat (pyproject.toml)
44
attrs==25.1.0 # via jsonschema, referencing
55
babel==2.17.0 # via mkdocs-material
6-
beautifulsoup4==4.13.0 # via linkchecker, mkdocs-htmlproofer-plugin
6+
beautifulsoup4==4.13.1 # via linkchecker, mkdocs-htmlproofer-plugin
77
black==25.1.0 # via ansible-compat (pyproject.toml)
88
cairocffi==1.7.1 # via cairosvg
99
cairosvg==2.7.1 # via mkdocs-ansible
1010
certifi==2025.1.31 # via requests
1111
cffi==1.17.1 # via cairocffi, cryptography
1212
charset-normalizer==3.4.1 # via requests
13-
click==8.1.8 # via black, mkdocs, mkdocstrings
13+
click==8.1.8 # via black, mkdocs
1414
colorama==0.4.6 # via griffe, mkdocs-material
1515
coverage==7.6.10 # via ansible-compat (pyproject.toml)
1616
cryptography==44.0.0 # via ansible-core
@@ -39,21 +39,21 @@ mkdocs==1.6.1 # via mkdocs-ansible, mkdocs-autorefs, mkdocs-gen-file
3939
mkdocs-ansible==24.12.0 # via ansible-compat (pyproject.toml)
4040
mkdocs-autorefs==1.3.0 # via mkdocstrings, mkdocstrings-python
4141
mkdocs-gen-files==0.5.0 # via mkdocs-ansible
42-
mkdocs-get-deps==0.2.0 # via mkdocs
42+
mkdocs-get-deps==0.2.0 # via mkdocs, mkdocstrings
4343
mkdocs-htmlproofer-plugin==1.3.0 # via mkdocs-ansible
4444
mkdocs-macros-plugin==1.3.7 # via mkdocs-ansible
45-
mkdocs-material==9.6.1 # via mkdocs-ansible
45+
mkdocs-material==9.6.2 # via mkdocs-ansible
4646
mkdocs-material-extensions==1.3.1 # via mkdocs-ansible, mkdocs-material
4747
mkdocs-minify-plugin==0.8.0 # via mkdocs-ansible
4848
mkdocs-monorepo-plugin==1.1.0 # via mkdocs-ansible
49-
mkdocstrings==0.27.0 # via mkdocs-ansible, mkdocstrings-python
50-
mkdocstrings-python==1.13.0 # via mkdocs-ansible
49+
mkdocstrings==0.28.0 # via mkdocs-ansible, mkdocstrings-python
50+
mkdocstrings-python==1.14.0 # via mkdocs-ansible
5151
mypy-extensions==1.0.0 # via black
5252
packaging==24.2 # via ansible-core, black, mkdocs, mkdocs-macros-plugin, pytest, ansible-compat (pyproject.toml)
5353
paginate==0.5.7 # via mkdocs-material
5454
pathspec==0.12.1 # via black, mkdocs, mkdocs-macros-plugin
5555
pillow==11.1.0 # via cairosvg, mkdocs-ansible
56-
platformdirs==4.3.6 # via black, mkdocs-get-deps, mkdocstrings
56+
platformdirs==4.3.6 # via black, mkdocs-get-deps
5757
pluggy==1.5.0 # via pytest
5858
pycparser==2.22 # via cffi
5959
pygments==2.19.1 # via mkdocs-material

.config/pydoclint-baseline.txt

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -127,12 +127,6 @@ src/ansible_compat/schema.py
127127
DOC601: Class `JsonSchemaError`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
128128
DOC603: Class `JsonSchemaError`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [data_path: str, expected: bool | int | str, found: str, json_path: str, message: str, relative_schema: str, schema_path: str, validator: str]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
129129
DOC201: Method `JsonSchemaError.to_friendly` does not have a return section in docstring
130-
DOC001: Function/method `validate`: Potential formatting errors in docstring. Error message: Expected a colon in 'SchemaError if the schema is invalid'. (Note: DOC001 could trigger other unrelated violations under this function/method too. Please fix the docstring formatting first.)
131-
DOC101: Function `validate`: Docstring contains fewer arguments than in function signature.
132-
DOC103: Function `validate`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [data: JSON, schema: JSON].
133-
DOC201: Function `validate` does not have a return section in docstring
134-
DOC501: Function `validate` has "raise" statements, but the docstring does not have a "Raises" section
135-
DOC503: Function `validate` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: []. Raised exceptions in the body: ['jsonschema.SchemaError'].
136130
--------------------
137131
test/conftest.py
138132
DOC101: Function `runtime`: Docstring contains fewer arguments than in function signature.

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ plugins:
4141
- mkdocstrings:
4242
handlers:
4343
python:
44-
import:
44+
inventories:
4545
- https://docs.python.org/3/objects.inv
4646
options:
4747
# heading_level: 2
48-
docstring_style: sphinx
48+
docstring_style: google
4949
docstring_options:
5050
ignore_init_summary: yes
5151

src/ansible_compat/schema.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def validate(
8181
Any errors encountered
8282
8383
Raises:
84-
SchemaError if the schema is invalid
84+
jsonschema.SchemaError: if the schema is invalid
8585
"""
8686
errors: list[JsonSchemaError] = []
8787

0 commit comments

Comments
 (0)