Add sphinx.ext.imgconverter extension to make SVGs build in LateX (#240)

* Add sphinx.ext.imgconverter extension to make SVGs build in LateX * Suppress epub unknown files warning * Add documentation on testing LateX and epub docs versions
HEPData · Nov 15, 2023 · 7f7a07c · 7f7a07c
1 parent a58dcae
commit 7f7a07c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -56,7 +56,8 @@ def __getattr__(cls, name):
 extensions = [
     'sphinx.ext.githubpages',
     'sphinx_mdinclude',
-    'sphinx.ext.autodoc'
+    'sphinx.ext.autodoc',
+    'sphinx.ext.imgconverter',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -83,6 +84,9 @@ def __getattr__(cls, name):
 # This pattern also affects html_static_path and html_extra_path .
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
+# Suppress warnings for unknown epub files (.nojekyll)
+suppress_warnings = ['epub.unknown_project_files']
+
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 

diff --git a/docs/dev.rst b/docs/dev.rst
@@ -110,6 +110,7 @@ After installing the ``hepdata_lib`` package, move into the ``hepdata_lib/docs``
     pip install -r requirements.txt
 
 Then you can build the documentation locally with Sphinx using ``make html`` and view the output by opening a web browser at ``_build/html/index.html``.
+In addition, please also test whether building the LateX (``make latexpdf``) and epub (``make epub``) versions works.
 
 
 Analysing the code