From afafef6e0ed658434137c9b69c519b8f6dcf4f2b Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Thu, 26 Jun 2025 16:22:14 -0400 Subject: [PATCH] build: Normalize conf.py. Use html_css_files and html_js_files. --- docs/_static/{basic.css => custom.css} | 0 docs/_templates/layout.html | 2 -- docs/conf.py | 27 ++++++-------------------- 3 files changed, 6 insertions(+), 23 deletions(-) rename docs/_static/{basic.css => custom.css} (100%) diff --git a/docs/_static/basic.css b/docs/_static/custom.css similarity index 100% rename from docs/_static/basic.css rename to docs/_static/custom.css diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index c68368339..5310a83dc 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -1,5 +1,3 @@ -{% set css_files = css_files + ["_static/basic.css"] %} -{% set script_files = script_files + ["_static/renderjson.js", "_static/script.js"] %} {% extends "!layout.html" %} {% block mobile_nav %} diff --git a/docs/conf.py b/docs/conf.py index 98d1c159b..fa9122f66 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,11 +1,8 @@ # Configuration file for the Sphinx documentation builder. # -# This file only contains a selection of the most common options. For a full -# list see the documentation: +# For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html -# -- Path setup -------------------------------------------------------------- - import csv import json import os @@ -19,6 +16,7 @@ from sphinx.locale import get_translation # -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "Open Contracting Data Standard" copyright = "Open Contracting Partnership" @@ -27,12 +25,9 @@ version = "1.1" release = "1.1.5" - # -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ "myst_parser", "sphinx.ext.ifconfig", @@ -42,28 +37,18 @@ "sphinx_design", ] -# Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/docson/[!p]**", "**/docson/package*.json"] - # -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# html_theme = "standard_theme" # 'pydata_sphinx_theme' html_theme_path = [standard_theme.get_html_theme_path()] html_favicon = "_static/favicon-16x16.ico" - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] +html_css_files = ["custom.css"] +html_js_files = ["renderjson.js", "script.js"] # -- Local configuration -----------------------------------------------------