Skip to content

Commit 85fa33b

Browse files
committed
Reenable error on sphinx nitpick warning
Also add sphinx nitpick exceptions
1 parent 06fe277 commit 85fa33b

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

docs/conf.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,24 @@
7171
("py:class", "'object'"),
7272
("py:class", "'id'"),
7373
("py:class", "typing_extensions.Literal"),
74+
("py:class", "number"),
75+
("py:class", "pythonSoftIoc.RecordWrapper"),
76+
("py:class", "pytac.lattice.Lattice"),
77+
("py:exc", "pytac.FieldException"),
78+
("py:exc", "pytac.ControlSystemException"),
79+
("py:exc", "pytac.HandleException"),
80+
("py:class", "at.lattice_object.Lattice"),
81+
("py:class", "numpy._typing._array_like._Buffer"),
82+
("py:class", "numpy._typing._array_like._SupportsArray"),
83+
("py:class", "numpy.dtype"),
84+
("py:class", "numpy._typing._nested_sequence._NestedSequence"),
85+
("py:class", "at.elements.Element"),
86+
("py:class", "numpy.typing.NDArray"),
87+
("py:class", "at.lattice.Lattice"),
88+
("py:class", "obj"),
89+
("py:class", "class"),
90+
("py:class", "at.lattice.lattice_object.Lattice"),
91+
("py:class", "cothread.Event"),
7492
]
7593

7694
# Both the class’ and the __init__ method’s docstring are concatenated and

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ commands =
104104
pre-commit: pre-commit run --all-files --show-diff-on-failure {posargs}
105105
type-checking: mypy src tests {posargs}
106106
tests: pytest --cov=atip --cov-report term --cov-report xml:cov.xml {posargs}
107-
docs: sphinx-{posargs:build -E --keep-going} -T docs build/html
107+
docs: sphinx-{posargs:build -EW --keep-going} -T docs build/html
108108
"""
109109
# Add -W flag to sphinx-build if you want to fail on warnings
110110

0 commit comments

Comments
 (0)