Skip to content

refactor: separate project-specific conf #14

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
robredpath merged 1 commit into from
Feb 19, 2026
Merged

refactor: separate project-specific conf #14

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
16 changes: 10 additions & 6 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
#
# NOTE: This file is designed to be synced across all IATI documentation repos.
# Project-specific settings are imported from project_info.py.

import os

Expand All @@ -10,14 +13,15 @@

import iati_sphinx_theme

# Import project-specific settings
from project_info import project, github_repository, languages

MESSAGE_CATALOG_NAME = "iati-sphinx-theme"
_ = get_translation(MESSAGE_CATALOG_NAME)

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
# These are kept for compatibility but shouldn't appear anywhere on the final website.

project = "IATI Docs Base"
author = "IATI Secretariat"
language = "en"

Expand All @@ -39,11 +43,11 @@

html_theme = "iati_sphinx_theme"
html_theme_options = { # See https://iati-sphinx-theme.readthedocs-hosted.com/en/latest/#configuration for additional options and info
"github_repository": "https://github.com/IATI/sphinx-theme",
"header_title_text": _("IATI Docs Base"),
"github_repository": github_repository,
"header_title_text": _(project),
"header_eyebrow_text": _("IATI Documentation"),
"languages": ["en", "fr", "es"],
"project_title": _("IATI Docs Base"),
"languages": languages,
"project_title": _(project),
"show_download_links": True,
}

Expand Down
12 changes: 12 additions & 0 deletions docs/project_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Project-specific configuration for Sphinx documentation.
# This file contains settings that vary per repository.
# The main conf.py imports these values and can be synced across all repos.

# Project name (used for titles, headers, and Sphinx internals)
project = "IATI Docs Base"

# GitHub repository URL (for "Edit on GitHub" links)
github_repository = "https://github.com/IATI/iati-docs-base"

# Supported languages for the documentation
languages = ["en", "fr", "es"]