Skip to content

Commit d28c48a

Browse files
committed
fix docs ci
1 parent a82cecb commit d28c48a

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/source/conf.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
# List of patterns, relative to source directory, that match files and
106106
# directories to ignore when looking for source files.
107107
# This pattern also affects html_static_path and html_extra_path .
108-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
108+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store","generated/waveform_editor.cli._excepthook.rst"]
109109

110110
# The name of the Pygments (syntax highlighting) style to use.
111111
pygments_style = "sphinx"
@@ -297,7 +297,13 @@
297297
def escape_underscores(string):
298298
return string.replace("_", r"\_")
299299

300+
# Get around issue where param contains an invalid docstring
301+
def patch_param_docstring(app, what, name, obj, options, lines):
302+
for i, line in enumerate(lines):
303+
if "**params" in line:
304+
lines[i] = line.replace("**params", "``**params``")
300305

301306
def setup(app):
302307
DEFAULT_FILTERS["escape_underscores"] = escape_underscores
303308
app.add_css_file("waveform_editor.css")
309+
app.connect("autodoc-process-docstring", patch_param_docstring)

0 commit comments

Comments
 (0)