Skip to content

Commit

Permalink
doc: Exclude documentation_options.js from default theme
Browse files Browse the repository at this point in the history
`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.

Signed-off-by: Benjamin Drung <[email protected]>
  • Loading branch information
bdrung authored and dwoz committed Dec 10, 2023
1 parent 3069063 commit b9b0c24
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/_themes/saltstack/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

{# Remove old version of jQuery #}
{% set js_blacklist = [
'_static/documentation_options.js',
'_static/jquery.js',
] %}

Expand Down

0 comments on commit b9b0c24

Please sign in to comment.