Skip to content

Commit 791caed

Browse files
committed
docs(conf): Note pydocstyle updates
1 parent 8aff08c commit 791caed

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# flake8: NOQA: E501
2+
"""Sphinx documentation configuration for tmuxp."""
23
import contextlib
34
import inspect
45
import pathlib
@@ -212,12 +213,13 @@ def linkcode_resolve(domain: str, info: t.Dict[str, str]) -> t.Union[None, str]:
212213

213214

214215
def remove_tabs_js(app: "Sphinx", exc: Exception) -> None:
215-
# Fix for sphinx-inline-tabs#18
216+
"""Fix for sphinx-inline-tabs#18."""
216217
if app.builder.format == "html" and not exc:
217218
tabs_js = pathlib.Path(app.builder.outdir) / "_static" / "tabs.js"
218219
with contextlib.suppress(FileNotFoundError):
219220
tabs_js.unlink() # When python 3.7 deprecated, use missing_ok=True
220221

221222

222223
def setup(app: "Sphinx") -> None:
224+
"""Sphinx setup hook."""
223225
app.connect("build-finished", remove_tabs_js)

0 commit comments

Comments
 (0)