mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-29 15:56:07 +00:00
1636c49134
REUSE is an initiative by FSFE, which intends to make licensing easier with best practices to display legal information through comment headers on source files that can be easily human and machine readable. Because these files are new and translation shall involve a lot of people as copyright holders, now is the best time to adopt REUSE. As a first implementation, this commit intentionally limits the scope to i18n directory. Cherry-picked fromc737ed0612anda2445af6d0Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
49 lines
1.8 KiB
Python
49 lines
1.8 KiB
Python
# SPDX-FileCopyrightText: 2024 Slavi Pantaleev <slavi@devture.com>
|
|
# SPDX-FileCopyrightText: 2024 Suguru Hirahara <acioustick@noreply.codeberg.org>
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
# Also see the `i18n/` directory.
|
|
#
|
|
# 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 = 'matrix-docker-ansible-deploy'
|
|
copyright = '2018-%Y, Slavi Pantaleev, Aine Etke, MDAD community members'
|
|
author = 'Slavi Pantaleev, Aine Etke, MDAD community members'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
needs_sphinx = '8.1' # For the copyright year placeholder (%Y). Specified with pyproject.toml as well.
|
|
|
|
extensions = [
|
|
'myst_parser',
|
|
'sphinx_markdown_builder'
|
|
]
|
|
myst_gfm_only = True
|
|
myst_heading_anchors = 4 # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#auto-generated-header-anchors
|
|
|
|
master_doc = 'README'
|
|
source_suffix = {'.md': 'markdown'}
|
|
|
|
# Though the default config file advocates exclude_patterns, it is straightforward for us to use include_patterns to select directories explicitly.
|
|
include_patterns = [
|
|
'docs/*',
|
|
'i18n/README.md',
|
|
'*.md',
|
|
]
|
|
|
|
locale_dirs = ['i18n/locales/']
|
|
gettext_compact = False
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
# html_theme = 'alabaster'
|
|
# html_static_path = ['_static']
|