[v2] Some Sphinx improvements

[PATCH v2 0/8] Some Sphinx improvements

Posted by marcandre.lureau@redhat.com 2 years, 6 months ago

From: Marc-André Lureau <marcandre.lureau@redhat.com>

Hi,

I have collected a few Sphinx-related improvements to improve depfile generation
and add some keyboard navigation. Hope you'll like it.

v2:
 - fix test 'output:' regression
 - fix javascript indentation (Paolo)
 - split "meson: remove explicit extensions dependency file list" (Paolo)

Marc-André Lureau (8):
  docs/sphinx: add loaded modules to generated depfile
  docs/sphinx: add static files to generated depfile
  docs/sphinx: add templates files to generated depfile
  tests/qapi-schema/meson: add depfile to sphinx doc
  meson: drop sphinx_extn_depends
  meson: drop sphinx_template_files
  docs/sphinx: set navigation_with_keys=True
  docs/sphinx: add 's' keyboard binding to focus search

 docs/conf.py                  |  7 ++++++-
 docs/meson.build              | 10 ----------
 docs/sphinx-static/custom.js  |  9 +++++++++
 docs/sphinx/depfile.py        | 19 +++++++++++++++++--
 tests/qapi-schema/meson.build |  6 ++++--
 5 files changed, 36 insertions(+), 15 deletions(-)
 create mode 100644 docs/sphinx-static/custom.js

-- 
2.33.0.721.g106298f7f9

Re: [PATCH v2 0/8] Some Sphinx improvements

Posted by John Snow 2 years, 5 months ago

On Fri, Oct 15, 2021 at 6:57 AM <marcandre.lureau@redhat.com> wrote:

> From: Marc-André Lureau <marcandre.lureau@redhat.com>
>
> Hi,
>
> I have collected a few Sphinx-related improvements to improve depfile
> generation
> and add some keyboard navigation. Hope you'll like it.
>
> v2:
>  - fix test 'output:' regression
>  - fix javascript indentation (Paolo)
>  - split "meson: remove explicit extensions dependency file list" (Paolo)
>
> Marc-André Lureau (8):
>   docs/sphinx: add loaded modules to generated depfile
>   docs/sphinx: add static files to generated depfile
>   docs/sphinx: add templates files to generated depfile
>   tests/qapi-schema/meson: add depfile to sphinx doc
>   meson: drop sphinx_extn_depends
>   meson: drop sphinx_template_files
>   docs/sphinx: set navigation_with_keys=True
>   docs/sphinx: add 's' keyboard binding to focus search
>
>  docs/conf.py                  |  7 ++++++-
>  docs/meson.build              | 10 ----------
>  docs/sphinx-static/custom.js  |  9 +++++++++
>  docs/sphinx/depfile.py        | 19 +++++++++++++++++--
>  tests/qapi-schema/meson.build |  6 ++++--
>  5 files changed, 36 insertions(+), 15 deletions(-)
>  create mode 100644 docs/sphinx-static/custom.js
>
> --
> 2.33.0.721.g106298f7f9
>
>
The javascript blurb selecting the correct DOM node being any better
probably requires the search input box itself being given an 'id'
parameter, but I don't know if that's something the theme we're using
allows us to customize in any way. I'm not a webdev at all, so ... I'll
assume it's fine?

Reviewed-by: John Snow <jsnow@redhat.com>

Re: [PATCH v2 0/8] Some Sphinx improvements

Posted by Paolo Bonzini 2 years, 6 months ago

On 15/10/21 12:53, marcandre.lureau@redhat.com wrote:
> From: Marc-André Lureau <marcandre.lureau@redhat.com>
> 
> Hi,
> 
> I have collected a few Sphinx-related improvements to improve depfile generation
> and add some keyboard navigation. Hope you'll like it.
> 
> v2:
>   - fix test 'output:' regression
>   - fix javascript indentation (Paolo)
>   - split "meson: remove explicit extensions dependency file list" (Paolo)
> 
> Marc-André Lureau (8):
>    docs/sphinx: add loaded modules to generated depfile
>    docs/sphinx: add static files to generated depfile
>    docs/sphinx: add templates files to generated depfile
>    tests/qapi-schema/meson: add depfile to sphinx doc
>    meson: drop sphinx_extn_depends
>    meson: drop sphinx_template_files
>    docs/sphinx: set navigation_with_keys=True
>    docs/sphinx: add 's' keyboard binding to focus search
> 
>   docs/conf.py                  |  7 ++++++-
>   docs/meson.build              | 10 ----------
>   docs/sphinx-static/custom.js  |  9 +++++++++
>   docs/sphinx/depfile.py        | 19 +++++++++++++++++--
>   tests/qapi-schema/meson.build |  6 ++++--
>   5 files changed, 36 insertions(+), 15 deletions(-)
>   create mode 100644 docs/sphinx-static/custom.js
> 

Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>

I think the patches could be reorg'ed as 4, 1+5 squashed, 2+6 squashed, 
3, 7, 8, but that is not a requirement.

Paolo