#!/usr/bin/env python3
#
# config.py
"""
Internal configuration for ``sphinx-toolbox``.
"""
#
# Copyright © 2020-2021 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.
#
# stdlib
from typing import List
# 3rd party
from apeye.requests_url import RequestsURL
from sphinx.application import Sphinx
# this package
from sphinx_toolbox.utils import Config, add_nbsp_substitution
__all__ = ("MissingOptionError", "InvalidOptionError", "validate_config", "ToolboxConfig")
[docs]class MissingOptionError(ValueError):
"""
Subclass of :exc:`ValueError` to indicate a missing configuration option.
"""
[docs]class InvalidOptionError(ValueError):
"""
Subclass of :exc:`ValueError` to indicate an invalid value for a configuration value.
"""
[docs]def validate_config(app: Sphinx, config: ToolboxConfig) -> None:
"""
Validate the provided configuration values.
See :class:`~sphinx_toolbox.config.ToolboxConfig` for a list of the configuration values.
:param app: The Sphinx application.
:param config:
:type config: :class:`~sphinx.config.Config`
"""
# this package
from sphinx_toolbox import github, source
source._configure(app, config)
github.validate_config(app, config)
add_nbsp_substitution(config)