fixeria has submitted this change. ( https://gerrit.osmocom.org/c/pysim/+/42543?usp=email ) Change subject: docs/conf.py: silence autosectionlabel duplicate-label warnings ...................................................................... docs/conf.py: silence autosectionlabel duplicate-label warnings sphinxarg.ext generates generic sub-headings ("Named arguments", "Positional arguments", "Sub-commands", "General options", ...) for every argparse command and tool. These repeat across many files and trigger large numbers of autosectionlabel duplicate-label warnings. Two-pronged fix: * `autosectionlabel_maxdepth = 3` eliminates the depth-4+ warnings (sub-headings inside each individual command block). * `suppress_warnings` per file silences the residual depth-3 collisions ("serial reader", "decode_hex", "sub-commands", ...) that still appear across tool documentation files. Cross-references into these generic argparse-generated sections are not a supported use-case, so suppressing the warnings is appropriate. Change-Id: I9cdf2a4f6cbd435b16b90ab668205600ffd7c3b0 --- M docs/conf.py 1 file changed, 17 insertions(+), 0 deletions(-) Approvals: laforge: Looks good to me, approved Jenkins Builder: Verified osmith: Looks good to me, but someone else must approve diff --git a/docs/conf.py b/docs/conf.py index ef40070..dc86817 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -64,3 +64,20 @@ html_static_path = ['_static'] autoclass_content = 'both' + +# Workaround for duplicate label warnings: +# https://github.com/sphinx-doc/sphinx-argparse/issues/14 +# +# sphinxarg.ext generates generic sub-headings ("Named arguments", +# "Positional arguments", "Sub-commands", "General options", ...) for every +# argparse command/tool. These repeat across many files and trigger tons +# of autosectionlabel duplicate-label warnings - suppress them. +autosectionlabel_maxdepth = 3 +suppress_warnings = [ + 'autosectionlabel.saip-tool', + 'autosectionlabel.shell', + 'autosectionlabel.smpp2sim', + 'autosectionlabel.smpp-ota-tool', + 'autosectionlabel.suci-keytool', + 'autosectionlabel.trace', +] -- To view, visit https://gerrit.osmocom.org/c/pysim/+/42543?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: I9cdf2a4f6cbd435b16b90ab668205600ffd7c3b0 Gerrit-Change-Number: 42543 Gerrit-PatchSet: 3 Gerrit-Owner: fixeria <vyanitskiy@sysmocom.de> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria <vyanitskiy@sysmocom.de> Gerrit-Reviewer: laforge <laforge@osmocom.org> Gerrit-Reviewer: osmith <osmith@sysmocom.de>