doc: Exclude documentation_options.js from default theme

[bdrung]

documentation_options.js from the default theme sets the option URL_ROOT to:

document.getElementById("documentation_options").getAttribute('data-url_root')

This requires that the script element for documentation_options.js includes the tag id="documentation_options" and sets the
data-url_root tag. Otherwise evaluating URL_ROOT will fail and building the documentation during the Debian package build will fail:

dh_sphinxdoc: error: DOCUMENTATION_OPTIONS does not define URL_ROOT

The variable DOCUMENTATION_OPTIONS is directly set layout.html and therefore documentation_options.js does not need to be included. So just exclude it.

[bdrung]

Rebased on master.

[bdrung]

Rebased on master. Let's see if all tests passes or if unrelated test cases fail.

[Ch3LL]

@barbaricyawps can you review here please

[barbaricyawps]

Recommend closing this PR as the fix appears to have been merged in by someone else, possibly later.

[barbaricyawps]

@bdrung , I'm afraid I don't understand enough about javascript to understand why this PR is necessary and your description doesn't seem to help me. One thing that I'm confused about is why you're adding a reference to a file named _static/documentation_options.js when this file doesn't exist in the root folder being referenced.

What does setting the js_blacklist do?

[bdrung]

js_blacklist is used in layout.html:

    {% if scriptfile not in js_blacklist %}
    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
    {% endif %}

_static/documentation_options.js is generated by sphinx, but this file is not needed since layout.html specifies everything needed itself:

    <script>
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:    '{{ url_root }}',
            VERSION:     '{{ release|e }}',
            LANGUAGE: '{{ language }}',
            COLLAPSE_INDEX: false,
            BUILDER: '{{ builder }}',
            FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
            LINK_SUFFIX: '{{ link_suffix }}',
            HAS_SOURCE: {{ has_source|lower }},
            SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}',
            NAVIGATION_WITH_KEYS: {{ 'true' if theme_navigation_with_keys|tobool else 'false'}}
        };
    </script>

[MKLeb]

@bdrung Would you be able to provide an example of this causing the failure you described? Logs, screenshots, whatever works.

[Ch3LL]

@bdrung can you answer @MKLeb 's question. Would like to progress this issue.