Adding A Javascript Script Tag Some Place So That It Works For Every File In Sphinx Documentation

April 27, 2023 Post a Comment

I am using Sphinx to write some notes. I am using the Mathjax extension for Math in the notes. The default size of the math is little larger than I would like. On the Mathjax page

Solution 1:

This can be done with a template:

Create a folder called templates in the Sphinx project directory.
In conf.py, add
```
templates_path = ["templates"]
```

In the templates directory, create a file called layout.html with the following contents:

{% extends "!layout.html" %}

{%- block extrahead %} 
 <script type="text/javascript">
       MathJax.Hub.Config({
           "HTML-CSS": {
               scale: 90
           }
       });
  </script>      
{% endblock %}

The <script> element will be included in the <head> of every generated HTML page.

The extrahead template block is empty by default. See the Sphinx templating documentation for details.

Solution 2:

Another method:

Use the script_files setting in your overridden layout.html file.

Solution 3:

If you want to avoid altering templates, you can just call Sphinx's add_js_file() from the setup() function in your Sphinx project's conf.py:

# conf.py

# ... other settings ...

def setup(app):
    # (create a setup() function if you don't already have one;
    # or add to the existing setup() ...)
    app.add_js_file("mathjax-config.js")

Create the file "mathjax-config.js" in your _static source directory. (Check the conf.py html_static_path setting to verify the static directories, or define one if needed.) Sphinx will copy it into the output directory during the build.

There's also an add_css_file() method for css files. And both of them can take either relative paths to your static source dirs, or full urls to external resources.

Before Sphinx v1.8, these functions were called add_javascript() and add_stylesheet().

And in Sphinx v3.0 or later, there's an even simpler approach that avoids the need for an extra JS file.

Solution 4:

In Sphinx 3.0 and later, the easiest way to add short snippets of JavaScript configuration is to call app.add_js_file(None, body="...JS code...") in your conf.py setup function. Example:

# In your Sphinx project's conf.py:

# 1. Add whatever JS code you need as a string constant.
#    (This example is from the original question.)
MATHJAX_CONFIG_JS = """
MathJax.Hub.Config({
  "HTML-CSS": {scale: 90}
});
"""

# 2. Create a setup() function if you don't already have one.
#    (If you do, just add to your existing setup() function.)
def setup(app):
    # 3. Tell Sphinx to add your JS code. Sphinx will insert
    #    the `body` into the html inside a <script> tag:
    app.add_js_file(None, body=MATHJAX_CONFIG_JS)

With this approach, you don't need to create a separate, static JS file.

(The body param was added in Sphinx 3.0; with earlier versions you can still use add_js_file() with a static JS file—see my earlier answer. And for for anything longer than a short config snippet, it's probably better to use an external file anyway.)

Solution 5:

The simplest solution for a conf.py only configuration might be to use the MathJax extension's config value mathjax_config (Available since 1.8). The value of mathjax_config is passed to MathJax.Hub.Config().

In your specific case, add the following to conf.py:

mathjax_config = {
    "HTML-CSS": {"scale": 90},
}

JavaScript Apprenticeships