[PATCH] RTEMS Docs: Fix search field

[Niteesh G. S.]

Hii

On Sun, 23 Feb, 2020, 2:07 AM Chris Johns, <chrisj at rtems.org> wrote:

> Hi
>
> How did you test this patch?
>

As I already told the search field works without this patch in sphinx
versions newer
than v1.6.4. This is a bug with all version of sphinx between v1.6.4 and
v.1.5.0
So to reproduce this bug in my local machine I had to install an older
version. And to make this accurate I wanted to install the same version of
the sphinx
as in the doc server.
So, I started looking at the sphinx release notes and commits. After trying
out different
versions, I came to the conclusion that the server uses sphinx v1.5.4 or
something
close to that. After installing v1.5.4 in my local machine I was able to
reproduce this bug.
And after applying this patch I was able to fix it.

sphinx_rtd_theme was also facing the same issue but it was fixed by a patch
same as
this
https://github.com/readthedocs/sphinx_rtd_theme/pull/346/commits/a5e0e304d30ed7aa1eacc6cca04514913b8d2385

I have applied the patch, cleaned, built and installed the built docs,
> opened
> the User manual and searched for "Windows" and it found nothing. I am not
> sure
> if this is my set up, I am in another country to the machine with the
> docs. It
> could be something else.
>
> Thanks
> Chris
>
> On 22/2/20 11:05 pm, G S Niteesh Babu wrote:
> > This patch fixes the search field which previously was not working
> > due to this commit 71dd8bfbf94417ad55b2444e1dbd219db266f335 in
> > sphinx.
> > ---
> >  common/sphinx_rtd_theme_rtems/layout.html     | 3 ++-
> >  common/sphinx_rtd_theme_rtems/layout_old.html | 3 ++-
> >  2 files changed, 4 insertions(+), 2 deletions(-)
> >
> > diff --git a/common/sphinx_rtd_theme_rtems/layout.html
> b/common/sphinx_rtd_theme_rtems/layout.html
> > index 44978c9..ca63b80 100644
> > --- a/common/sphinx_rtd_theme_rtems/layout.html
> > +++ b/common/sphinx_rtd_theme_rtems/layout.html
> > @@ -167,7 +167,8 @@
> >              VERSION:'{{ release|e }}',
> >              COLLAPSE_INDEX:false,
> >              FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
> > -            HAS_SOURCE:  {{ has_source|lower }}
> > +            HAS_SOURCE:  {{ has_source|lower }},
> > +            SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
> >          };
> >      </script>
> >      {%- for scriptfile in script_files %}
> > diff --git a/common/sphinx_rtd_theme_rtems/layout_old.html
> b/common/sphinx_rtd_theme_rtems/layout_old.html
> > index deb8df2..f0dc2af 100644
> > --- a/common/sphinx_rtd_theme_rtems/layout_old.html
> > +++ b/common/sphinx_rtd_theme_rtems/layout_old.html
> > @@ -91,7 +91,8 @@
> >          VERSION:     '{{ release|e }}',
> >          COLLAPSE_INDEX: false,
> >          FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
> > -        HAS_SOURCE:  {{ has_source|lower }}
> > +        HAS_SOURCE:  {{ has_source|lower }},
> > +        SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
> >        };
> >      </script>
> >      {%- for scriptfile in script_files %}
> >
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20200223/2343a39f/attachment.html>