On Sun, Mar 29, 2020 at 7:36 AM Thomas Goirand <zigo@debian.org> wrote:
Hi there!
Thanks for your reply.
On 3/28/20 10:05 PM, Akihiro Motoki wrote:
On Sat, Mar 28, 2020 at 6:34 PM Thomas Goirand <zigo@debian.org> wrote:
Sphinx 2.4 has been uploaded to Experimental. I just received bug reports against the OpenStack packages because some of them cannot be built with Sphinx 2.4. Here's the list:
- ironic - os-api-ref
I can build the document with sphinx 2.4.4.
For Ironic, the bug report is here: https://bugs.debian.org/955069
For os-api-ref, here: https://bugs.debian.org/955098
the bug in os-api-ref is *not* in its documentation, but in os-api-ref itself, unfortunately (failure to run unit tests...).
All os-api-ref unittests succeed in the OpenStack CI. For example, https://zuul.opendev.org/t/openstack/build/af69856854424ef59d7b096f4dbffc1b It uses sphinx 2.4.4 and sphinx-testing 1.0.1. At a quick look of sphinx-testing, os-api-ref tests only works with os-api-ref>=1.0.1, while test-requirements.txt says os-api-ref>=0.7.2. read_text() method is from sphinx_testing.path.path class, but up to sphinx-testing 1.0.0 str is returned as app.outdir. The simplest solution would be to update test-requirements.txt to os-api-ref>=1.0.1 to clarify the requirements. Perhaps Debian testing uses sphinx-testing <1.0.1.
- aodh - cloudkitty - kombu
This is not part of OpenStack and is not found in opendev.org.
Kombu, probably, however it's used in many OpenStack projects, like taskflow, oslo.messaging, ceilometer, heat, mistral, murano...
My intention is to refer only kombu, so I used "This". You mentioned "OpenStack packages" so I just would like to clarify it. Of course, it would be nice to fix them.
The other 2 really are in opendev:
https://opendev.org/openstack/cloudkitty https://opendev.org/openstack/aodh
- dracclient - glareclient - murano-pkg-check - os-xenapi - scciclient - sahara - sphinxcontrib-programoutput
This is not part of OpenStack and is not found in opendev.org.
Does your sentence intend to apply to all what you've quoted? :) Hopefully not ... and assuming not:
sphinxcontrib-programoutput is used in many docs in OpenStack, so it is also relevant to have it in the list.
Same as the above.
- tempest-horizon
sphinx document is not actually used and the content was not changed under the initial cookiecutter commit. I proposed a patch to drop sphinx related stuffs. Hope it works for you.
Thanks. I'll drop the doc package then.
- doc8 doc8 was retired Jul 2019.
One correction on doc8. The repository was retired, but more precisely, as mentioned at https://opendev.org/x/doc8, it was moved to https://github.com/PyCQA/doc8 Thanks, Akihiro
Cheers,
Thomas Goirand (zigo)