[incubator-age-website] branch master updated: Enable Latex style math (#22)

[jo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

joshinnis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-age-website.git


The following commit(s) were added to refs/heads/master by this push:
     new 9d93e7a  Enable Latex style math (#22)
9d93e7a is described below

commit 9d93e7a777ee096a5330cd66bf8438968d3ca944
Author: Pieterjan De Potter <pi...@ugent.be>
AuthorDate: Fri Oct 29 18:00:55 2021 +0200

    Enable Latex style math (#22)
---
 .github/workflows/build-documentation.yml | 3 +++
 README.md                                 | 4 ++--
 docs/conf.py                              | 5 +++++
 3 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml
index 0c19d6f..5a84273 100644
--- a/.github/workflows/build-documentation.yml
+++ b/.github/workflows/build-documentation.yml
@@ -10,6 +10,9 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Install Latex and dvisvgm
+        run: sudo apt-get install -y texlive-latex-base texlive-latex-extra texlive-extra-utils
+
       - name: Setup Python
         uses: actions/setup-python@v2
         with:
diff --git a/README.md b/README.md
index fe35409..5a14429 100644
--- a/README.md
+++ b/README.md
@@ -8,10 +8,10 @@
 
 ## Build the documentation locally (first time)
 
-* Install requirements
+* Install requirements (the latex and dvisvgm commands are required to display math)
 
 ```shell
-sudo apt install python3 virtualenv
+sudo apt install python3 virtualenv texlive-latex-base texlive-latex-extra texlive-extra-utils
 ```
 
 * Clone this repository
diff --git a/docs/conf.py b/docs/conf.py
index 684e72a..a24aff5 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -34,6 +34,7 @@ extensions = [
     'sphinx_rtd_theme',
     'sphinx_multiversion',
     'myst_parser',
+    'sphinx.ext.imgmath',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -80,6 +81,10 @@ smv_remote_whitelist = r'^.*$'
 smv_released_pattern = r'^remotes/.*$'
 smv_prefer_remote_refs = True
 
+# -- imgmath options ---------------------------------------------------------
+imgmath_image_format = 'svg'
+imgmath_use_preview = True
+
 
 def setup(app):
     app.add_css_file('css/custom.css')  # may also be an URL