From b57b4fe7ed2ef3b87e131e89d0c0be9939b7bb8e Mon Sep 17 00:00:00 2001 From: utensil Date: Sat, 30 Mar 2024 16:40:28 +0800 Subject: [PATCH] Tweaks and workarounds to fix the doc style locally --- doc/conf.py | 6 ++++-- doc/readthedocs-pip-requirements.txt | 11 ++++++----- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 160cc2f5..d0386a11 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -53,6 +53,7 @@ 'sphinx_markdown_tables', 'releases', 'sphinxcontrib.bibtex', + 'sphinx_rtd_theme', # local extensions 'md_include', @@ -231,7 +232,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -268,7 +269,7 @@ # html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -285,6 +286,7 @@ html_context = { 'css_files': [ + '_static/css/theme.css', '_static/theme_overrides.css', # override wide tables in RTD theme ], } diff --git a/doc/readthedocs-pip-requirements.txt b/doc/readthedocs-pip-requirements.txt index ebc50e19..6036a085 100644 --- a/doc/readthedocs-pip-requirements.txt +++ b/doc/readthedocs-pip-requirements.txt @@ -10,16 +10,17 @@ scipy ipykernel nbsphinx numba -sphinx_rtd_theme>=0.5.0 +sphinx-rtd-theme + sphinx-markdown-tables notedown -semantic-version==2.6.0 -releases>=1.6.1 +semantic-version +releases sphinxcontrib-bibtex nbsphinx-link # the first release to support f-strings -pygments >= 2.5.0 +pygments # previous releases did not render our README badges correctly -recommonmark>=0.6.0 +recommonmark