Hi Guillaume, I proposed a patch to resolve this for transportpce here ( https://git.opendaylight.org/gerrit/c/transportpce/+/91185).
The cause of this is due to us merging support for sphinx-tabs into the lfdocs-conf project which is a central configuration for documentation projects ( https://gerrit.linuxfoundation.org/infra/c/releng/docs-conf/+/64363). The problem is that sphinx-tabs does not declare support for the Sphinx linkchecker and our linkchecker configuration is configured to fail on warnings. There is an open PR on GitHub to declare this support ( https://github.com/djungelorm/sphinx-tabs/pull/54) however I'm not going to hold my breath on this one getting merged as it seems to have no recent activity. Sorry for the inconvenience here as we did not think to test "linkcheck" compatibility with this plugin when we were reviewing this patch. The good news however is we don't need to fail on warnings with the linkchecker so my transportpce patch disables fail on warnings. The reason is because the regular "docs" tox builder already covers warning failures, the only reason we need linkcheck check is to make sure there's no broken links in docs which is already covered as an error and not warning so I think this is a reasonable workaround. What this means for other ODL projects is if you have a linkcheck environment declared in your tox.ini, make sure that it is not failing on warnings (via the "-W" flag) in the Sphinx command. I will spend some time today proposing similar patches to other ODL projects that have this configuration. Regards, Thanh On Fri, Jul 10, 2020 at 4:49 AM Guillaume Lambert via lists.opendaylight.org <[email protected]> wrote: > Hi all > > > > For your information, releng tox docs-linkcheck job is failing on our > gate since yesterday. > > If I understand the logs below correctly, there is an internal warning > raised by the new Sphynx version and > > with the current configuration, it is treated by releng as an error… > > > > > https://logs.opendaylight.org/releng/vex-yul-odl-jenkins-1/transportpce-tox-verify-aluminium/824 > > RemovedInSphinx40Warning: The app.add_javascript() is deprecated. Please > use app.add_js_file() instead. > > 18:01:43 app.add_javascript(path) > > 18:01:43 18:01:43 Warning, treated as error: > > 18:01:43 Not copying tabs assets! Not compatible with linkcheck builder > > 18:01:43 ERROR: InvocationError for command > /w/workspace/transportpce-tox-verify-aluminium/.tox/docs-linkcheck/bin/sphinx-build > -W -b linkcheck -d > /w/workspace/transportpce-tox-verify-aluminium/.tox/docs-linkcheck/tmp/doctrees > ../docs/ > /w/workspace/transportpce-tox-verify-aluminium/docs/_build/linkcheck > (exited with code 2) > > 18:01:43 ___________________________________ summary > ____________________________________ > > 18:01:43 py3: commands succeeded > > 18:01:43 docs: commands succeeded > > 18:01:43 ERROR: docs-linkcheck: commands failed > > > > > > > > To restore our gate, I have no other workaround from the moment than to > force this job to success. Cf change 91042 > <https://git.opendaylight.org/gerrit/c/transportpce/+/91042>. > > > > Best Regards > > Guillaume > > > > > > _________________________________________________________________________________________________________________________ > > Ce message et ses pieces jointes peuvent contenir des informations > confidentielles ou privilegiees et ne doivent donc > pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu > ce message par erreur, veuillez le signaler > a l'expediteur et le detruire ainsi que les pieces jointes. Les messages > electroniques etant susceptibles d'alteration, > Orange decline toute responsabilite si ce message a ete altere, deforme ou > falsifie. Merci. > > This message and its attachments may contain confidential or privileged > information that may be protected by law; > they should not be distributed, used or copied without authorisation. > If you have received this email in error, please notify the sender and delete > this message and its attachments. > As emails may be altered, Orange is not liable for messages that have been > modified, changed or falsified. > Thank you. > > >
-=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#1174): https://lists.opendaylight.org/g/infrastructure/message/1174 Mute This Topic: https://lists.opendaylight.org/mt/75506639/21656 Group Owner: [email protected] Unsubscribe: https://lists.opendaylight.org/g/infrastructure/unsub [[email protected]] -=-=-=-=-=-=-=-=-=-=-=-
