Skip to content

build: Normalize conf.py. Use html_css_files and html_js_files. #1737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 26, 2025
Merged

build: Normalize conf.py. Use html_css_files and html_js_files. #1737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 docs/_static/basic.css → docs/_static/custom.css
View file
Open in desktop
File renamed without changes.
2 changes: 0 additions & 2 deletions docs/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 %}
Expand Down
27 changes: 6 additions & 21 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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"
Expand All @@ -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",
Expand All @@ -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 -----------------------------------------------------
Expand Down