Add missing SOURCELINK_SUFFIX

[mikkeloscar]

Adds DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX which is expected by searchtools.js_t

Related sphinx commit: sphinx-doc/sphinx@71dd8bf

I'm using sphinx 1.5-1 and without this fix, search doesn't work:

Uncaught TypeError: Cannot read property 'length' of undefined
    at displayNextItem (searchtools.js:543)
    at Object.query (searchtools.js:574)
    at Object.setIndex (searchtools.js:362)
    at <anonymous>:1:8
    at p (jquery.js:2)
    at Function.globalEval (jquery.js:2)
    at text script (jquery.js:4)
    at Nb (jquery.js:4)
    at A (jquery.js:4)
    at XMLHttpRequest.<anonymous> (jquery.js:4)

[ericholscher]

Thanks for sending this along!

[mikkeloscar]

Hey, what is your release schedule? I looks like a while since the last release :)

[17amrut29]

@ericholscher - When is this fix going to be released?

[dschiller]

Modify C:\Python27\Lib\site-packages\sphinx_rtd_theme\layout.html:

Unfixed:

164 <script type="text/javascript">
165         var DOCUMENTATION_OPTIONS = {
166             URL_ROOT:'{{ url_root }}',
167             VERSION:'{{ release|e }}',
168             COLLAPSE_INDEX:false,
169             FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
170             HAS_SOURCE:  {{ has_source|lower }}
171         };
172 </script>

Fixed:

164 <script type="text/javascript">
165         var DOCUMENTATION_OPTIONS = {
166             URL_ROOT:'{{ url_root }}',
167             VERSION:'{{ release|e }}',
168             COLLAPSE_INDEX:false,
169             FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
170             HAS_SOURCE:  {{ has_source|lower }},
171             SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
172         };
173 </script>

[alejandrovr]

Hello,
Which would be the equivalent path for C:\Python27\Lib\site-packages\sphinx_rtd_theme\layout.html in linux? Does it exist?
Could it be something like: .../python/site-packages/sphinx/theme/basic/layout.html ?
Thanks in advance,
Alejandro.

[mikkeloscar]

@alejandrovr something like /usr/lib/python3.6/site-packages/sphinx_rtd_theme/layout.html

[alejandrovr]

@mikkeloscar hmm, weird. I do not have that file, and even better, I do not have any sphinx_rtd_theme directory. However, in the searchtools.js, if I change
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
by
var suffix = 'py';

everything works, so the problem is there. I am using Sphinx 1.5.6., btw.

Thanks anyway,

Alejandro

[jmckenna]

This exact issue still exists with the recent Sphinx 2.0.0 release and sphinx_rtd_theme 0.4.3:

404 (not found) /_sources/myfolder/filename.txt.txt

...where the correct file is named "filename.txt"

(test live at https://mapserver.org/search.html )

[jpreese]

Recently ran into this as well. Is there a known sphinx_rtd_theme + sphinx version combination that works?

When using search, all of the links end with undefined

[stsewd]

@jpreese think one or two releases back in sphinx will fix the problem, but I think this is already fixed in master and we just need to push a new version, I'll see if we can do that.

[jpreese]

Thank you @stsewd! Much appreciated. I have yet been able to find a RTD/Sphinx combination that works.

edit: Just saw that 0.5.1 was released and it does appear to be working with Sphinx 3.4.2!

RUN pip3 install sphinx==3.4.2 sphinx_rtd_theme==0.5.1

Thanks!