From a600a1cc03cfcb456d70e24fc818c300979dc361 Mon Sep 17 00:00:00 2001 From: Johannes Blaschke Date: Thu, 16 Dec 2021 22:30:54 +0100 Subject: [PATCH 1/3] escape backslash in strings --- source/doc-0.81/conf.py | 4 ++-- source/doc-0.82-p1/conf.py | 4 ++-- source/doc-0.82/conf.py | 4 ++-- source/doc-0.83/conf.py | 4 ++-- source/doc-0.84/conf.py | 4 ++-- source/doc-0.85/conf.py | 4 ++-- source/doc-dev/conf.py | 4 ++-- source/main/conf.py | 4 ++-- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/source/doc-0.81/conf.py b/source/doc-0.81/conf.py index 45090a11..ada3f843 100644 --- a/source/doc-0.81/conf.py +++ b/source/doc-0.81/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\usepackage{mathpazo}', +latex_elements = {'fontpkg': '\\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\usepackage{amssymb} \usepackage{stmaryrd}'} + 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-0.82-p1/conf.py b/source/doc-0.82-p1/conf.py index 07214981..7d9490b3 100644 --- a/source/doc-0.82-p1/conf.py +++ b/source/doc-0.82-p1/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\usepackage{mathpazo}', +latex_elements = {'fontpkg': '\\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\usepackage{amssymb} \usepackage{stmaryrd}'} + 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-0.82/conf.py b/source/doc-0.82/conf.py index b2846229..2b5c010b 100644 --- a/source/doc-0.82/conf.py +++ b/source/doc-0.82/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\usepackage{mathpazo}', +latex_elements = {'fontpkg': '\\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\usepackage{amssymb} \usepackage{stmaryrd}'} + 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-0.83/conf.py b/source/doc-0.83/conf.py index f88be984..b4e09759 100644 --- a/source/doc-0.83/conf.py +++ b/source/doc-0.83/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\usepackage{mathpazo}', +latex_elements = {'fontpkg': '\\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\usepackage{amssymb} \usepackage{stmaryrd}'} + 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-0.84/conf.py b/source/doc-0.84/conf.py index 85b7fd6f..646dae6a 100644 --- a/source/doc-0.84/conf.py +++ b/source/doc-0.84/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\usepackage{mathpazo}', +latex_elements = {'fontpkg': '\\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\usepackage{amssymb} \usepackage{stmaryrd}'} + 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-0.85/conf.py b/source/doc-0.85/conf.py index 9dea49b6..b5083637 100644 --- a/source/doc-0.85/conf.py +++ b/source/doc-0.85/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\usepackage{mathpazo}', +latex_elements = {'fontpkg': '\\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\usepackage{amssymb} \usepackage{stmaryrd}'} + 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-dev/conf.py b/source/doc-dev/conf.py index af581995..22fe439c 100644 --- a/source/doc-dev/conf.py +++ b/source/doc-dev/conf.py @@ -224,11 +224,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\usepackage{mathpazo}', +latex_elements = {'fontpkg': '\\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\usepackage{amssymb} \usepackage{stmaryrd}'} + 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/main/conf.py b/source/main/conf.py index 8f4cb936..802cdcef 100644 --- a/source/main/conf.py +++ b/source/main/conf.py @@ -224,11 +224,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\usepackage{mathpazo}', +latex_elements = {'fontpkg': '\\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\usepackage{amssymb} \usepackage{stmaryrd}'} + 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " From d6ffd4052cae1613a65a3fc55bc9208f2f765db2 Mon Sep 17 00:00:00 2001 From: Johannes Blaschke Date: Thu, 16 Dec 2021 22:38:44 +0100 Subject: [PATCH 2/3] update readme --- README.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.rst b/README.rst index 07dc74ef..6b69ed62 100644 --- a/README.rst +++ b/README.rst @@ -5,6 +5,13 @@ Elemental documentation and webpage The repository contains the source for the pages at http://libelemental.org. +* How to: set up python environment + :: + + pip install sphinx sphinx_rtd_theme spinx-serve + + This will install python dependencies. + * How to: generate web pages :: @@ -42,3 +49,10 @@ http://libelemental.org. * NOTE: This documentation was forked from fenics-web, which may be found at https://bitbucket.org/fenics-project/fenics-web. + +* How to preview on your local machine + :: + + sphinx-serve -b build + + This will host a webserver containing the rendered webpages From 48c101144fe9f85cae2e0c98ffb0156e2d8e7823 Mon Sep 17 00:00:00 2001 From: Johannes Blaschke Date: Fri, 17 Dec 2021 10:37:31 +0100 Subject: [PATCH 3/3] use r strings for latex --- source/doc-0.81/conf.py | 4 ++-- source/doc-0.82-p1/conf.py | 4 ++-- source/doc-0.82/conf.py | 4 ++-- source/doc-0.83/conf.py | 4 ++-- source/doc-0.84/conf.py | 4 ++-- source/doc-0.85/conf.py | 4 ++-- source/doc-dev/conf.py | 4 ++-- source/main/conf.py | 4 ++-- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/source/doc-0.81/conf.py b/source/doc-0.81/conf.py index ada3f843..a04d31c0 100644 --- a/source/doc-0.81/conf.py +++ b/source/doc-0.81/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\\usepackage{mathpazo}', +latex_elements = {'fontpkg': r'\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} + 'preamble': r'\usepackage{amssymb} \usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-0.82-p1/conf.py b/source/doc-0.82-p1/conf.py index 7d9490b3..4022edb4 100644 --- a/source/doc-0.82-p1/conf.py +++ b/source/doc-0.82-p1/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\\usepackage{mathpazo}', +latex_elements = {'fontpkg': r'\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} + 'preamble': r'\usepackage{amssymb} \usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-0.82/conf.py b/source/doc-0.82/conf.py index 2b5c010b..47671cc3 100644 --- a/source/doc-0.82/conf.py +++ b/source/doc-0.82/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\\usepackage{mathpazo}', +latex_elements = {'fontpkg': r'\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} + 'preamble': r'\usepackage{amssymb} \usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-0.83/conf.py b/source/doc-0.83/conf.py index b4e09759..524e5057 100644 --- a/source/doc-0.83/conf.py +++ b/source/doc-0.83/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\\usepackage{mathpazo}', +latex_elements = {'fontpkg': r'\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} + 'preamble': r'\usepackage{amssymb} \usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-0.84/conf.py b/source/doc-0.84/conf.py index 646dae6a..838afa85 100644 --- a/source/doc-0.84/conf.py +++ b/source/doc-0.84/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\\usepackage{mathpazo}', +latex_elements = {'fontpkg': r'\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} + 'preamble': r'\usepackage{amssymb} \usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-0.85/conf.py b/source/doc-0.85/conf.py index b5083637..e76aa4f0 100644 --- a/source/doc-0.85/conf.py +++ b/source/doc-0.85/conf.py @@ -220,11 +220,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\\usepackage{mathpazo}', +latex_elements = {'fontpkg': r'\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} + 'preamble': r'\usepackage{amssymb} \usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/doc-dev/conf.py b/source/doc-dev/conf.py index 22fe439c..c0087549 100644 --- a/source/doc-dev/conf.py +++ b/source/doc-dev/conf.py @@ -224,11 +224,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\\usepackage{mathpazo}', +latex_elements = {'fontpkg': r'\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} + 'preamble': r'\usepackage{amssymb} \usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} " diff --git a/source/main/conf.py b/source/main/conf.py index 802cdcef..293e3e66 100644 --- a/source/main/conf.py +++ b/source/main/conf.py @@ -224,11 +224,11 @@ def skip_member(app, what, name, obj, skip, options): # If false, no module index is generated. #latex_use_modindex = True -latex_elements = {'fontpkg': '\\usepackage{mathpazo}', +latex_elements = {'fontpkg': r'\usepackage{mathpazo}', 'pointsize': '11pt', 'papersize': 'a4paper', 'fontenc': '', - 'preamble': '\\usepackage{amssymb} \\usepackage{stmaryrd}'} + 'preamble': r'\usepackage{amssymb} \usepackage{stmaryrd}'} # Parameters affecting the LaTeX PNGs in the HTML files pngmath_latex_preamble = r" \usepackage{stmaryrd} "