Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Then, add `ewokssphinx` to the list of `extensions` in the Sphinx configuration

extensions = [
...,
"ewokssphinx"
"ewokssphinx",
]
```

Expand Down
5 changes: 3 additions & 2 deletions doc/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,10 @@ To use attribute docstrings instead of `description` to document the fields, set
from ewokscore.model import BaseInputModel
from pydantic import ConfigDict


class Inputs(BaseInputModel):
model_config = ConfigDict(use_attribute_docstrings=True)
model_config = ConfigDict(use_attribute_docstrings=True)

planet: str = "Earth"
"""The planet on which the search will be made"""

Expand Down
5 changes: 1 addition & 4 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,7 @@ Then, add `ewokssphinx` to the list of `extensions` in the Sphinx configuration

...

extensions = [
...,
"ewokssphinx"
]
extensions = [..., "ewokssphinx"]
```

## Contents
Expand Down
19 changes: 14 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ test = [
]
dev = [
"ewokssphinx[test]",
"ruff",
"ruff>=0.16.0",
]
doc = [
"ewokssphinx[test]",
Expand All @@ -59,12 +59,21 @@ ewokssphinx = ["*.css"]
omit = ['*/tests/*']

[tool.ruff.lint]
select = ["E", "F", "I", "S"]
ignore = ["E501"]
select = [
"E", # pycodestyle errors
"F", # pyflakes
"I", # isort
"S", # flake8-bandit
]
ignore = [
"E501", # line too long
]

[tool.ruff.lint.per-file-ignores]
# Ignore `S101` (assert used violations) in all test files
"src/ewokssphinx/tests/*.py" = ["S101"]
"src/ewokssphinx/tests/*.py" = [
"S101" # allow asserts
]

[tool.ruff.lint.isort]
force-single-line = true
known-first-party = ["ewokssphinx"]
Loading