Skip to content

Commit bef209a

Browse files
authored
DOC: Fix non-standard Input/Output docstring section management (#3505)
## Changes proposed in this pull request Fix non-standard Input/Output docstring section management: map `Inputs` and `Outputs` to `params_style` and `returns_style`, respectively, for `napoleon` custom sections (instead of mapping them to `Parameters`). Documentation: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#confval-napoleon_custom_sections ## Documentation that should be reviewed Any workflow function.
2 parents 03e209f + eebd67b commit bef209a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@
6969
# https://github.com/sphinx-contrib/napoleon/pull/10 is merged.
7070
napoleon_use_param = False
7171
napoleon_custom_sections = [
72-
('Inputs', 'Parameters'),
73-
('Outputs', 'Parameters'),
72+
('Inputs', 'params_style'),
73+
('Outputs', 'returns_style'),
7474
]
7575

7676
# The suffix(es) of source filenames.

0 commit comments

Comments
 (0)