From 2ada5a011cb9e20f0c22ec788a32414d352c6e58 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 25 Nov 2023 14:38:41 -0600 Subject: [PATCH] chore(docs[conf]): pydocstyle manual fixes --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index e6399b96d..fbc808157 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,5 @@ # flake8: NOQA: E501 +"""Sphinx configuration for libtmux.""" import contextlib import inspect import pathlib @@ -202,6 +203,7 @@ def linkcode_resolve(domain: str, info: t.Dict[str, str]) -> t.Union[None, str]: def remove_tabs_js(app: "Sphinx", exc: Exception) -> None: + """Remove tabs.js from _static after build.""" # Fix for sphinx-inline-tabs#18 if app.builder.format == "html" and not exc: tabs_js = pathlib.Path(app.builder.outdir) / "_static" / "tabs.js" @@ -210,4 +212,5 @@ def remove_tabs_js(app: "Sphinx", exc: Exception) -> None: def setup(app: "Sphinx") -> None: + """Configure Sphinx app hooks.""" app.connect("build-finished", remove_tabs_js)