On 05/12/2024 17:05, Ilya Maximets wrote: > On 12/5/24 15:54, Kevin Traynor wrote: >> Hi, >> >> I'm hitting doc build error [1] with Sphinx v1.7.6 on RHEL 8. >> >> The issue is with duplicate options for ovs-flowviz because the options >> are described for different formats. e.g. >> # grep 'option:: -h,' ovs-flowviz.8.rst >> .. option:: -h, --help >> .. option:: -h, --heat-map >> .. option:: -h, --heat-map >> .. option:: -h, --html >> >> I tried to suppress the autosectionlabel warnings but that option was >> introduced in Sphinx 2.1 :( There is probably some easy if you know it >> fix, but I spent a bit of time searching/trying and I didn't come up >> with something. Any ideas ? >> > > Do you know from which version such non-duplication duplications are > correctly handled? >
I didn't see anything clear in changelogs. The issue is not present with v3.4.3 on RHEL 9. Meanwhile v2.1 enables the ability to suppress the autosectionlabel warnings. > In general v1.7.6 is a very old release. We may need to bump the > requirements for the sphinx version instead. > Yep, in fact the conf.py says we support v1.1. >> thanks, >> Kevin. >> >> [1] >> make all-am >> make[1]: Entering directory '/root/ovs' >> sphinx-build-3 -b html -W -n -d ./Documentation/_build/doctrees >> ./Documentation ./Documentation/_build/html && touch docs-check >> Running Sphinx v1.7.6 >> Cannot find 'ovs-sphinx-theme' package. Falling back to default theme. >> loading pickled environment... not yet created >> building [mo]: targets for 0 po files that are out of date >> building [html]: targets for 124 source files that are out of date >> updating environment: 124 added, 0 changed, 0 removed >> reading sources... [100%] tutorials/ovs-conntrack >> >> >> Warning, treated as error: > > Is building without -Werror an option? :) > Yes, we could use that as an alternative in the short term to upgrading Sphinx version. Currently we are using sphinx-build -W to fail on warnings. >> /root/ovs/Documentation/ref/ovs-flowviz.8.rst:92:Duplicate explicit >> target name: "cmdoption-h". >> make[1]: *** [Makefile:6896: docs-check] Error 2 >> make[1]: Leaving directory '/root/ovs' >> make: *** [Makefile:3132: all] Error 2 >> > _______________________________________________ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev
