conf.py

"""sphinx configuration"""
import time
from datetime import datetime

year = datetime.today().year

project = "reMarkable Guide"
copyright = f"2023-{year}, Eeems"
author = "Nathaniel 'Eeems' van Diepen"

html_theme_path = ["_themes"]
html_static_path = ["_static"]
templates_path = ["_templates"]

highlight_language = "shell"
html_title = "reMarkable Guide"
html_theme = "oxide"
master_doc = "sitemap"
html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
html_permalinks_icon = "#"
html_baseurl = "https://remarkable.guide"
html_use_opensearch = "https://remarkable.guide"
html_js_files = [
    "https://peek.eeems.website/peek.js",
    (
        "https://browser.sentry-cdn.com/6.16.1/bundle.tracing.min.js",
        {
            "integrity": "sha384-hySah00SvKME+98UjlzyfP852AXjPPTh2vgJu26gFcwTlZ02/zm82SINaKTKwIX2",
            "crossorigin": "anonymous",
        },
    ),
    "oxide.js",
    (
        "https://giscus.app/client.js",
        {
            "data-repo": "Eeems-Org/remarkable.guide",
            "data-repo-id": "R_kgDOI7Ab8A",
            "data-category": "General",
            "data-category-id": "DIC_kwDOI7Ab8M4CY3cm",
            "data-mapping": "pathname",
            "data-strict": "1",
            "data-reactions-enabled": "1",
            "data-emit-metadata": "1",
            "data-input-position": "top",
            "data-theme": "transparent_dark",
            "data-lang": "en",
            "data-loading": "lazy",
            "crossorigin": "anonymous",
            "async": "async",
        },
    ),
]

ogp_site_url = html_baseurl
ogp_description_length = 200
ogp_site_name = project
ogp_image = "/_images/favicon.svg"
ogp_use_first_image = True
ogp_type = "article"
ogp_enable_meta_description = True
ogp_custom_meta_tags = [
    f'<meta property="og:article:modified_time" content="{datetime.utcnow().isoformat()}" />',
]

# Do not enable sphinx.ext.autosectionlabel
# The expectation is that we explicitely add references
extensions = [
    "sphinxcontrib.fulltoc",
    "sphinxcontrib.spelling",
    "sphinxext.opengraph",
    "sphinx.ext.doctest",
    "sphinx_tabs.tabs",
    "sphinx_copybutton",
    "sphinx_gitstamp",
]

rst_prolog = """
.. role:: raw-html(raw)
    :format: html
"""

spelling_word_list_filename = "spelling_wordlist.txt"

linkcheck_anchors_ignore_for_url = [
    r"https://docs\.ackee\.electerious\.com/.*",
    r"https://github\.com/.*",
]
linkcheck_ignore = [
    r"https://web.archive.org/.*",
    r"https://github.com/search\\?.*",
]
linkcheck_allowed_redirects = {
    r"https://support\.remarkable\.com": "https://support.remarkable.com/s/",
    r"https://discord\.gg/ATqQGfu": "https://discord.com/invite/ATqQGfu",
}
linkcheck_retries = 5

sphinx_tabs_valid_builders = ["linkcheck"]