From ef67a8197f1b1ad4e1c2ff50dbe0f0e61377a135 Mon Sep 17 00:00:00 2001 From: Simon Conseil Date: Thu, 1 Aug 2024 08:48:16 +0200 Subject: [PATCH] update sphinx conf for RTD --- docs/conf.py | 14 +++++++------- tests/sample/sigal.conf.py | 6 +++--- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index dc630dd..91bb9cb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,13 +1,7 @@ -# import os -# import sys +import os from sigal import __version__ -# 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. -# sys.path.append(os.path.abspath("..")) - # -- General configuration ---------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. @@ -76,6 +70,12 @@ pygments_dark_style = "monokai" # -- Options for HTML output -------------------------------------------------- +# 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 +html_context = {"READTHEDOCS": os.environ.get("READTHEDOCS", "") == "True"} + html_theme = "furo" html_theme_options = { diff --git a/tests/sample/sigal.conf.py b/tests/sample/sigal.conf.py index 4d9ae39..ff928d1 100644 --- a/tests/sample/sigal.conf.py +++ b/tests/sample/sigal.conf.py @@ -34,14 +34,14 @@ watermark = "watermark.png" watermark_position = (10, 10) watermark_opacity = 0.3 -theme = "colorbox" +theme = "photoswipe" thumb_size = (200, 150) rss_feed = {"feed_url": "http://127.0.0.1:8000/feed.rss", "nb_items": 10} atom_feed = {"feed_url": "http://127.0.0.1:8000/feed.atom", "nb_items": 10} -# theme = 'photoswipe' +# theme = 'colorbox' # theme = 'galleria' # thumb_size = (280, 210) # galleria_theme = 'folio' -show_map = True +# show_map = True