Files
foundry/docs/source/conf.py
Rachel Clune 4e3feffc12 Docs add analytics (#264)
* Adding Google Analytics to the Foundry documentation

The analytics are under Rachel Clune's OSMF account and will only be used for reporting to the Rosetta Commons Board

* Add simple analytics tracking to the foundry docs

Simple analytics does not collect any personal information.
The page view information will only be used for reporting to the Rosetta board and prioritizing future work.
2026-04-07 10:15:21 -07:00

65 lines
2.4 KiB
Python

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'foundry'
copyright = '2025, Institute for Protein Design, University of Washington'
author = 'Institute for Protein Design, University of Washington'
release = '0.1.7'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = ["myst_parser",
"sphinx_copybutton"
]
templates_path = ['_templates']
exclude_patterns = ["readme.md", "readmelink.md", "readme_link.rst"]
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'furo'
html_static_path = ['_static', '../../models/rfd3/.assets']
html_theme_options = {
"sidebar_hide_name":False,
#"announcement": "<em>THIS DOCUMENTATION IS CURRENTLY UNDER CONSTRUCTION</em>",
"light_css_variables": {
"color-brand-primary": "#F68A33", # Rosetta Teal
"color-brand-content": "#37939B", # Rosetta Orange
#"color-admonition-background": "#CCE8E8", # Rosetta light orange
"font-stack": "Open Sans, sans-serif",
"font-stack--headings": "Open Sans, sans-serif",
"color-background-hover": "#DCE8E8ff",
"color-announcement-background" : "#F68A33dd",
"color-announcement-text": "#070707",
"color-brand-visited": "#37939B",
},
"dark_css_variables": {
"color-brand-primary": "#37939B", # Rosetta teal
"color-brand-content": "#F68A33", # Rosetta orange
#"color-admonition-background": "#20565B", # Rosetta light orange
"font-stack": "Open Sans, sans-serif",
"font-stack--headings": "Open Sans, sans-serif",
"color-brand-visited": "#37939B",
}
}
source_suffix = {
".rst": "restructuredtext",
".md": "markdown",
}
html_js_files = [
('https://scripts.simpleanalyticscdn.com/latest.js', {'async': 'async', 'defer': 'defer'}),
]
suppress_warnings = ["myst.xref_missing"]