openstackdocstheme

  1. Bug #1880331
  2. Comment #2

Comment 2 for bug 1880331

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstackdocstheme (master)

Reviewed: https://review.opendev.org/753283
Committed: https://git.openstack.org/cgit/openstack/openstackdocstheme/commit/?id=9efc192021896559ffcb89093a4331c343156974
Submitter: Zuul
Branch: master

commit 9efc192021896559ffcb89093a4331c343156974
Author: Stephen Finucane <email address hidden>
Date: Tue Sep 22 11:43:18 2020 +0100

    js: Set 'LINK_SUFFIX'

    Sphinx 3.0.0 changed the behavior of JavaScript-based search utility,
    changing the configuration option used to determine the suffix for
    search results from 'html_file_suffix' to 'html_link_suffix' [1]. We
    were manually overriding 'DOCUMENTATION_OPTIONS' and were not setting
    the 'LINK_SUFFIX' attribute, which maps to this config option, meaning
    our resulting URLs looked like 'fooundefined', where 'foo' is the name
    of the file.

    Add 'LINK_SUFFIX', resolving this issue.

    [1] https://github.com/sphinx-doc/sphinx/commit/a717ffec78

    Change-Id: I06488225cf0431e601f16e0f1047a6088a11d5bd
    Signed-off-by: Stephen Finucane <email address hidden>
    Closes-bug: #1880331