docs/conf.py

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

import os
import re
import subprocess
import sys

# required to get reference documentation to be built
sys.path.insert(0, os.path.abspath(".."))

apache_footer = """
<div class="apache-footer">
    <img width="200" src="/_static/apache-incubator-logo.svg" alt="Apache Incubator Logo" class="apache-incubator-logo">
    <div class="apache-notice">
        <p>Apache Hamilton is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
    </div>
    <div class="apache-copyright">
        <p>Apache, the names of Apache projects, and the feather logo are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.</p>
    </div>
</div>
"""

copyright = "The Apache Software Foundation, Licensed under the Apache License, Version 2.0."
project = "Hamilton"

html_theme = "furo"
html_title = "Hamilton"
html_theme_options = {
    "source_repository": "https://github.com/apache/hamilton",
    "source_branch": "main",
    "source_directory": "docs/",
    "announcement": "📢 Announcing the "
    + '<a target="_blank" href="https://www.meetup.com/global-hamilton-open-source-user-group-meetup/">Hamilton Meetup Group</a>. Sign up to attend events! 📢',
    "light_css_variables": {
        "color-announcement-background": "#ffba00",
        "color-announcement-text": "#091E42",
    },
    "dark_css_variables": {
        "color-announcement-background": "#ffba00",
        "color-announcement-text": "#091E42",
    },
    "footer_icons": [
        {
            "name": "Apache Stuff",
            "html": apache_footer,
            "url": "https://incubator.apache.org/",
        },
    ],
}
html_static_path = ["_static"]
templates_path = ['_templates']

html_css_files = [
    "testimonials.css",
    "custom.css",
]
extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.viewcode",
    "myst_nb",
    "sphinx_llms_txt",
    "sphinx_sitemap",
    "sphinxcontrib.mermaid",
    "docs.data_adapters_extension",
]

# sphinx-llms-txt configuration
llms_txt_title = "Apache Hamilton"
llms_txt_summary = (
    "Apache Hamilton is a lightweight Python framework for creating "
    "DAGs of data transformations using declarative function definitions."
)

nb_execution_mode = "off"

# this is required to get simplepdf to work
nb_mime_priority_overrides = [
    ["simplepdf", "application/vnd.jupyter.widget-view+json", 10],
    ["simplepdf", "application/javascript", 20],
    ["simplepdf", "text/html", 30],
    ["simplepdf", "image/svg+xml", 40],
    ["simplepdf", "image/png", 50],
    ["simplepdf", "image/gif", 60],
    ["simplepdf", "image/jpeg", 70],
    ["simplepdf", "text/markdown", 80],
    ["simplepdf", "text/latex", 90],
    ["simplepdf", "text/plain", 100],
]

exclude_patterns = [
    '_build',
    'Thumbs.db',
    '.DS_Store',
    'README.md',
]

# for the sitemap extension ---
# check if the current commit is tagged as a release (vX.Y.Z) and set the version
GIT_TAG_OUTPUT = subprocess.check_output(["git", "tag", "--points-at", "HEAD"])
current_tag = GIT_TAG_OUTPUT.decode().strip()
if re.match(r"^apache-hamilton-(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", current_tag):
    version = current_tag
else:
    version = "latest"
language = "en"
GIT_BRANCH_OUTPUT = subprocess.check_output(["git", "rev-parse", "--abbrev-ref", "HEAD"])
current_branch = GIT_BRANCH_OUTPUT.decode().strip()
if current_branch == "main":
    html_baseurl = "https://hamilton.apache.org/"
else:
    html_baseurl = "https://hamilton.staged.apache.org/"
html_extra_path = ["robots.txt"]
# ---