mbox

[PULL,v3,0/1] Rtd patches

Message ID 20210514111310.1756593-1-marcandre.lureau@redhat.com (mailing list archive)
State New, archived
Headers show

Pull-request

git@gitlab.com:marcandre.lureau/qemu.git tags/rtd-pull-request

Message

Marc-André Lureau May 14, 2021, 11:13 a.m. UTC
From: Marc-André Lureau <marcandre.lureau@redhat.com>

The following changes since commit 2d3fc4e2b069494b1e9e2e4a1e3de24cbc036426:

  Merge remote-tracking branch 'remotes/armbru/tags/pull-misc-2021-05-12' into staging (2021-05-13 20:13:24 +0100)

are available in the Git repository at:

  git@gitlab.com:marcandre.lureau/qemu.git tags/rtd-pull-request

for you to fetch changes up to 73e6aec6522e1edd63f631c52577b49a39bc234f:

  sphinx: adopt kernel readthedoc theme (2021-05-14 15:05:03 +0400)

----------------------------------------------------------------
Pull request

----------------------------------------------------------------

Marc-André Lureau (1):
  sphinx: adopt kernel readthedoc theme

 docs/_templates/editpage.html              |   5 -
 docs/conf.py                               |  52 ++++---
 docs/devel/_templates/editpage.html        |   5 -
 docs/interop/_templates/editpage.html      |   5 -
 docs/meson.build                           |   5 +-
 docs/specs/_templates/editpage.html        |   5 -
 docs/sphinx-static/theme_overrides.css     | 161 +++++++++++++++++++++
 docs/system/_templates/editpage.html       |   5 -
 docs/tools/_templates/editpage.html        |   5 -
 docs/user/_templates/editpage.html         |   5 -
 tests/docker/dockerfiles/alpine.docker     |   1 +
 tests/docker/dockerfiles/debian10.docker   |   1 +
 tests/docker/dockerfiles/fedora.docker     |   1 +
 tests/docker/dockerfiles/ubuntu.docker     |   1 +
 tests/docker/dockerfiles/ubuntu1804.docker |   1 +
 tests/docker/dockerfiles/ubuntu2004.docker |   1 +
 16 files changed, 200 insertions(+), 59 deletions(-)
 delete mode 100644 docs/_templates/editpage.html
 delete mode 100644 docs/devel/_templates/editpage.html
 delete mode 100644 docs/interop/_templates/editpage.html
 delete mode 100644 docs/specs/_templates/editpage.html
 create mode 100644 docs/sphinx-static/theme_overrides.css
 delete mode 100644 docs/system/_templates/editpage.html
 delete mode 100644 docs/tools/_templates/editpage.html
 delete mode 100644 docs/user/_templates/editpage.html

Comments

Peter Maydell May 14, 2021, 6:33 p.m. UTC | #1
On Fri, 14 May 2021 at 12:13, <marcandre.lureau@redhat.com> wrote:
>
> From: Marc-André Lureau <marcandre.lureau@redhat.com>
>
> The following changes since commit 2d3fc4e2b069494b1e9e2e4a1e3de24cbc036426:
>
>   Merge remote-tracking branch 'remotes/armbru/tags/pull-misc-2021-05-12' into staging (2021-05-13 20:13:24 +0100)
>
> are available in the Git repository at:
>
>   git@gitlab.com:marcandre.lureau/qemu.git tags/rtd-pull-request
>
> for you to fetch changes up to 73e6aec6522e1edd63f631c52577b49a39bc234f:
>
>   sphinx: adopt kernel readthedoc theme (2021-05-14 15:05:03 +0400)
>
> ----------------------------------------------------------------
> Pull request
>
> ----------------------------------------------------------------


Applied, thanks.

Please update the changelog at https://wiki.qemu.org/ChangeLog/6.1
for any user-visible changes.

-- PMM
Philippe Mathieu-Daudé May 15, 2021, 1:19 p.m. UTC | #2
On 5/14/21 8:33 PM, Peter Maydell wrote:
> On Fri, 14 May 2021 at 12:13, <marcandre.lureau@redhat.com> wrote:
>>
>> From: Marc-André Lureau <marcandre.lureau@redhat.com>
>>
>> The following changes since commit 2d3fc4e2b069494b1e9e2e4a1e3de24cbc036426:
>>
>>   Merge remote-tracking branch 'remotes/armbru/tags/pull-misc-2021-05-12' into staging (2021-05-13 20:13:24 +0100)
>>
>> are available in the Git repository at:
>>
>>   git@gitlab.com:marcandre.lureau/qemu.git tags/rtd-pull-request
>>
>> for you to fetch changes up to 73e6aec6522e1edd63f631c52577b49a39bc234f:
>>
>>   sphinx: adopt kernel readthedoc theme (2021-05-14 15:05:03 +0400)
>>
>> ----------------------------------------------------------------
>> Pull request
>>
>> ----------------------------------------------------------------
> 
> 
> Applied, thanks.

After rebasing I'm getting:

Program sphinx-build-3 found: YES
docs/meson.build:30: WARNING: /usr/bin/sphinx-build-3:
Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/home/phil/source/qemu/docs/conf.py", line 155, in <module>
    import sphinx_rtd_theme
ModuleNotFoundError: No module named 'sphinx_rtd_theme'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 361, in
eval_config_file
    execfile_(filename, namespace)
  File "/usr/lib/python3.8/site-packages/sphinx/util/pycompat.py", line
81, in execfile_
    exec(code, _globals)
  File "/home/phil/source/qemu/docs/conf.py", line 157, in <module>
    raise ConfigError(
sphinx.errors.ConfigError: The Sphinx 'sphinx_rtd_theme' HTML theme was
not found.

Is python3-sphinx_rtd_theme a required dependency now?

$ lsb_release -d
Description:    Fedora release 32 (Thirty Two)

Thanks,

Phil.
Marc-André Lureau May 15, 2021, 7:02 p.m. UTC | #3
Hi

On Sat, May 15, 2021 at 5:20 PM Philippe Mathieu-Daudé <philmd@redhat.com>
wrote:

> On 5/14/21 8:33 PM, Peter Maydell wrote:
> > On Fri, 14 May 2021 at 12:13, <marcandre.lureau@redhat.com> wrote:
> >>
> >> From: Marc-André Lureau <marcandre.lureau@redhat.com>
> >>
> >> The following changes since commit
> 2d3fc4e2b069494b1e9e2e4a1e3de24cbc036426:
> >>
> >>   Merge remote-tracking branch
> 'remotes/armbru/tags/pull-misc-2021-05-12' into staging (2021-05-13
> 20:13:24 +0100)
> >>
> >> are available in the Git repository at:
> >>
> >>   git@gitlab.com:marcandre.lureau/qemu.git tags/rtd-pull-request
> >>
> >> for you to fetch changes up to 73e6aec6522e1edd63f631c52577b49a39bc234f:
> >>
> >>   sphinx: adopt kernel readthedoc theme (2021-05-14 15:05:03 +0400)
> >>
> >> ----------------------------------------------------------------
> >> Pull request
> >>
> >> ----------------------------------------------------------------
> >
> >
> > Applied, thanks.
>
> After rebasing I'm getting:
>
> Program sphinx-build-3 found: YES
> docs/meson.build:30: WARNING: /usr/bin/sphinx-build-3:
> Configuration error:
> There is a programmable error in your configuration file:
>
> Traceback (most recent call last):
>   File "/home/phil/source/qemu/docs/conf.py", line 155, in <module>
>     import sphinx_rtd_theme
> ModuleNotFoundError: No module named 'sphinx_rtd_theme'
>
> During handling of the above exception, another exception occurred:
>
> Traceback (most recent call last):
>   File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 361, in
> eval_config_file
>     execfile_(filename, namespace)
>   File "/usr/lib/python3.8/site-packages/sphinx/util/pycompat.py", line
> 81, in execfile_
>     exec(code, _globals)
>   File "/home/phil/source/qemu/docs/conf.py", line 157, in <module>
>     raise ConfigError(
> sphinx.errors.ConfigError: The Sphinx 'sphinx_rtd_theme' HTML theme was
> not found.
>
> Is python3-sphinx_rtd_theme a required dependency now?
>
>
Yes, only If you --enable-docs. Otherwise, you should get a warning and doc
will be disabled. Mine is less ugly than yours, not sure why:

Program sphinx-build-3 found: YES (/usr/bin/sphinx-build-3)
../docs/meson.build:30: WARNING: /usr/bin/sphinx-build-3:
Configuration error:
The Sphinx 'sphinx_rtd_theme' HTML theme was not found.


Program python3 found: YES (/usr/bin/python3)
Peter Maydell May 16, 2021, 4:03 p.m. UTC | #4
On Sat, 15 May 2021 at 20:02, Marc-André Lureau
<marcandre.lureau@redhat.com> wrote:
> Otherwise, you should get a warning and doc will be disabled. Mine is less
> ugly than yours, not sure why:

I think that's a sphinx-version dependent thing. I requested that
they improve the support for conf.py raising ConfigError to produce
nicer error messages in https://github.com/sphinx-doc/sphinx/issues/7108
but if your sphinx is too old to have that improvement then you'll
get a warning message with the backtrace.

-- PMM
Philippe Mathieu-Daudé May 19, 2021, 11:24 a.m. UTC | #5
On 5/16/21 6:03 PM, Peter Maydell wrote:
> On Sat, 15 May 2021 at 20:02, Marc-André Lureau
> <marcandre.lureau@redhat.com> wrote:
>> Otherwise, you should get a warning and doc will be disabled. Mine is less
>> ugly than yours, not sure why:
> 
> I think that's a sphinx-version dependent thing. I requested that
> they improve the support for conf.py raising ConfigError to produce
> nicer error messages in https://github.com/sphinx-doc/sphinx/issues/7108
> but if your sphinx is too old to have that improvement then you'll
> get a warning message with the backtrace.

Ah, probably, the issue #7108 appears to be merged in milestone 3.0.0,
and the version installed on Fedora 32 is:

$ /usr/bin/sphinx-build-3 --version
sphinx-build-3 2.2.2

Thanks,

Phil.