diff --git a/docs/conf.py b/docs/conf.py index db6fba8..6e2b0fd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,365 +1,68 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- +# Configuration file for the Sphinx documentation builder. # -# IATI CDFD documentation build configuration file, -# created by sphinx-quickstart on Wed Nov 2 14:17:45 2016. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html -# 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", - "sphinxcontrib.opendataservices", - "sphinxcontrib.jsonschema", - "sphinx.ext.todo", - "sphinx.ext.autodoc", - "sphinx_togglebutton", - "sphinx.ext.autosectionlabel", -] +import os -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] +import sphinx.application +from sphinx.locale import get_translation -source_suffix = [".rst"] +import iati_sphinx_theme -# The encoding of source files. -# -# source_encoding = 'utf-8-sig' +MESSAGE_CATALOG_NAME = "iati-sphinx-theme" +_ = get_translation(MESSAGE_CATALOG_NAME) -# The master toctree document. -master_doc = "index" +# -- 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. -# General information about the project. project = "IATI Tool: Documentation" -copyright = ( - "2024 United Nations Development Programme, on behalf of the IATI Secretariat" -) author = "IATI Secretariat" - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = "0.0" -# The full version, including alpha/beta/rc tags. -release = "0.0" - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. language = "en" -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# -# today = '' -# -# Else, today_fmt is used as the format for a strftime call. -# -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.todo", + "sphinxcontrib.video", + "sphinxcontrib.youtube", +] -# -- Options for HTML output ---------------------------------------------- +templates_path = ["_templates"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = "iati_sphinx_theme" - -html_css_files = [ - "custom.css", -] - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -html_theme_options = { +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/iati-docs-base", - "header_title_text": "Country Development Finance Data", - "project_title": "CDFD: Documentation", - "tool_nav_items": {"CDFD": "https://countrydata.iatistandard.org/"}, - "languages": ["en"], + "header_title_text": _("Country Development Finance Data",), + "header_eyebrow_text": _("IATI Documentation"), + "languages": ["en", "fr", "es"], + "project_title": _("CDFD: Documentation",), + "show_download_links": True, } -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. -# " v documentation" by default. -# -# html_title = 'IATI CDFD Docs' - -# A shorter title for the navigation bar. Default is the same as html_title. -# -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# -# html_logo = None - -# The name of an image file (relative to this directory) to use as a favicon of -# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# -# html_favicon = None - -# 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". +# Add any paths that contain custom static files (such as style sheets, videos, +# images) 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"] -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# -# html_extra_path = [] - -# If not None, a 'Last updated on:' timestamp is inserted at every page -# bottom, using the given strftime format. -# The empty string is equivalent to '%b %d, %Y'. -# -# html_last_updated_fmt = None - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# -# html_additional_pages = {} - -# If false, no module index is generated. -# -# html_domain_indices = True - -# If false, no index is generated. -# -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' -# -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# 'ja' uses this config value. -# 'zh' user can custom change `jieba` dictionary path. -# -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "sphinxdoc" - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, "sphinx.tex", "IATI CDFD Docs", "IATI Secretariat", "manual"), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# -# latex_use_parts = False - -# If true, show page references after internal links. -# -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# -# latex_appendices = [] - -# It false, will not define \strong, \code, itleref, \crossref ... but only -# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added -# packages. -# -# latex_keep_old_macro_names = True - -# If false, no module index is generated. -# -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [(master_doc, "sphinx", "IATI CDFD Docs", [author], 1)] - -# If true, show URL addresses after external links. -# -# man_show_urls = False - +todo_include_todos = True # -- Options for Texinfo output ------------------------------------------- -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "sphinx", - "IATI CDFD Docs", - author, - "sphinx", - "One line description of project.", - "Miscellaneous", - ), +locale_dirs = [ + "locale", + os.path.join(os.path.dirname(iati_sphinx_theme.__file__), "locale"), ] -# Documents to append as an appendix to all manuals. -# -# texinfo_appendices = [] - -# If false, no module index is generated. -# -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# -# texinfo_no_detailmenu = False - - -locale_dirs = ["locale/"] # path is example but recommended. -gettext_compact = False # optional. -togglebutton_hint = "" +def setup(app: sphinx.application.Sphinx) -> None: + locale_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), "locale") + app.add_message_catalog(MESSAGE_CATALOG_NAME, locale_path) diff --git a/docs/data_fields.rst b/docs/data_fields.rst index 2b26e66..dae91f5 100644 --- a/docs/data_fields.rst +++ b/docs/data_fields.rst @@ -162,6 +162,6 @@ Value (EUR) ======================== The value of the transaction/budget row in Euros. -Value (Local currrency) +Value (Local currency) ======================== The value of the transaction/budget row in the local currency, customised for each country. diff --git a/docs/faq.rst b/docs/faq.rst index 7b16f8a..06b07f9 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -21,7 +21,8 @@ Frequently Asked Questions .. _faq_2: \2. When is CDFD updated? - CDFD is refreshed once per day. + CDFD is refreshed once per day. + Individual reporting organisations update their data at different frequencies, such as monthy, quarterly, or annually. .. _faq_3: diff --git a/requirements.in b/requirements.in index 24dc5c2..75920c7 100644 --- a/requirements.in +++ b/requirements.in @@ -1,5 +1,7 @@ sphinx sphinx-togglebutton sphinxcontrib-opendataservices +sphinxcontrib-video +sphinxcontrib-youtube sphinx-intl -iati-sphinx-theme +iati-sphinx-theme \ No newline at end of file