[all][doc] the openstack-tox-docs job is broken with Sphinx >= 5.0.0

Brian Rosmaita rosmaita.fossdev at gmail.com
Mon Jun 6 13:14:03 UTC 2022

On 6/6/22 12:27 AM, Takashi Kajinami wrote:
> Updating conf.py would be still required so it's better to work on it 
> earlier
> before the upper constraint is updated.

I was just looking into this, and as long as your conf.py does not 
explicitly set
   language = None
the default language is set to 'en' internally by Sphinx in 5.0.0+ [0]. 
  So as long as you have the language setting either missing or 
commented out in your conf.py, you should not see this warning (which, 
when treated as an error, breaks the doc build).


> On Mon, Jun 6, 2022 at 1:15 PM Takashi Kajinami <tkajinam at redhat.com 
> <mailto:tkajinam at redhat.com>> wrote:
>     Hi,
>     It seems the openstack-tox-docs job is broken in some projects
>     because of the following
>     change made in Sphinx >= 5.0.0 .
>     https://github.com/sphinx-doc/sphinx/commit/a3d09835522e6487cf93dcc871179db8d69e4180
>     <https://github.com/sphinx-doc/sphinx/commit/a3d09835522e6487cf93dcc871179db8d69e4180>
>     We currently have Sphinx 4.5.0 in upper-constraints.txt but some
>     projects (eg. Heat, Nova,
>     Neutron) are using only their own docs-constraints.txt and pull the
>     latest version which is 5.0.1 .
>     IMO we need to fix the problem by the following two steps, but I'd
>     appreciate
>     if anybody can share a better idea.
>       1. Update tox.ini to honor upper-constraints.txt. This is needed
>     in master and
>           stable/branches as well.
>       2. Update docs/source/conf.py to hard-code the language parameter
>     to 'en'.
>           This is required in master so that we can bump the upper
>     version later.
>     Thank you,
>     Takashi Kajinami

More information about the openstack-discuss mailing list