From d1161d44833770c7280703260680ed362896e566 Mon Sep 17 00:00:00 2001 From: "Davide P. Cervone" Date: Tue, 3 Sep 2024 14:57:19 -0400 Subject: [PATCH 1/4] Update configuration for ReadTheDocs --- conf.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/conf.py b/conf.py index 35e0d280..d3fed195 100644 --- a/conf.py +++ b/conf.py @@ -13,6 +13,17 @@ import sys, os +### DPVC -- from https://about.readthedocs.com/blog/2024/07/addons-by-default/ +# Define the canonical URL if you are using a custom domain on Read the Docs +html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") + +# Tell Jinja2 templates the build is running on Read the Docs +if os.environ.get("READTHEDOCS", "") == "True": + if "html_context" not in globals(): + html_context = {} + html_context["READTHEDOCS"] = True +### /DPVC + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. From b14bba6c9b5a0a17a3ce23a7e7e4c2a7e9afd3eb Mon Sep 17 00:00:00 2001 From: "Davide P. Cervone" Date: Tue, 5 Aug 2025 12:18:10 -0400 Subject: [PATCH 2/4] Move to v3.2 from v3.2-latest --- conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf.py b/conf.py index d3fed195..8824041a 100644 --- a/conf.py +++ b/conf.py @@ -39,7 +39,7 @@ #templates_path = ['_templates'] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = {'.rst': 'restructuredtext'} # The encoding of source files. #source_encoding = 'utf-8' From c3be2b9f804a0bbf05958a0b34831a46d9b2e195 Mon Sep 17 00:00:00 2001 From: "Davide P. Cervone" Date: Tue, 5 Aug 2025 13:17:10 -0400 Subject: [PATCH 3/4] Add version 4 link --- conf.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/conf.py b/conf.py index 8824041a..4405b9a6 100644 --- a/conf.py +++ b/conf.py @@ -112,6 +112,16 @@ # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] +# +# DPVC: Add warning about new version +# +rst_prolog = """.. attention:: + `Version 4 `_ is now the current version of MathJax. + This document is for version 3.2. +""" +# +# /DPVC +# # -- Options for HTML output --------------------------------------------------- From b681bed61ebc12008a292bee4947f2900155be33 Mon Sep 17 00:00:00 2001 From: "Davide P. Cervone" Date: Tue, 5 Aug 2025 14:42:39 -0400 Subject: [PATCH 4/4] Update configuration and CSS --- .readthedocs.yaml | 6 +++--- _static/custom.css | 36 ++++++++++++++++++++++++++++++++++-- 2 files changed, 37 insertions(+), 5 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 27e80f7f..a4e474fe 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -23,9 +23,9 @@ sphinx: # fail_on_warning: true # Optionally build your docs in additional formats such as PDF and ePub -# formats: -# - pdf -# - epub +formats: + - pdf + - epub # Optional but recommended, declare the Python requirements required # to build your documentation diff --git a/_static/custom.css b/_static/custom.css index 813f4327..8e2b363b 100644 --- a/_static/custom.css +++ b/_static/custom.css @@ -2,6 +2,38 @@ color: inherit; font-size: 85%; border: none; - background: #F0F0F0; - padding: 2px 3px 1px; + background: #E8E8E8; + padding: 2px 3px; + border-radius: .33em; +} + +.toctree-l1 > ul { + margin-top: 3px ! important; +} + +.toctree-l2 > ul { + margin-top: 0 ! important; + margin-bottom: 3px ! important; +} + +ul.simple > li { + margin-bottom: 10px; +} + +div.tight > ul.simple > li { + margin-bottom: 0; +} + +kbd { + display: inline-block; + padding: 3px 5px ! important; + font-size: 80% ! important; + line-height: 10px ! important; + color: #444d56 ! important; + vertical-align: middle ! important; + background-color: #fafbfc ! important; + border: solid 1.5px #c6cbd1 ! important; + border-bottom-color: #959da5 ! important; + border-radius: 3px ! important; + box-shadow: inset -.5px -1px 0 #959da5 ! important; }