add option to dynamically override configuration (#36)

* add option to dynamically override configuration

Signed-off-by: Martin Kloesch <martin.kloesch@gmail.com>

* fix formatting errors in documentation

Signed-off-by: Martin Kloesch <martin.kloesch@gmail.com>

---------

Signed-off-by: Martin Kloesch <martin.kloesch@gmail.com>

Author: kmhsonnenkind

README.rst

@@ -178,6 +178,19 @@ the recommended approach is to explicitly assign the name:
 
 This will prevent warnings from linters etc., but is not necessary for Sphinx to see the configuration.
 
+Additionally the ``SphinxConfig`` class takes an optional parameter ``config_overrides`` that
+can be used to dynamically update values from ``pyproject.toml``. This can be helpful for setting
+dynamic values like ``version``.
+
+.. code-block:: python3
+
+	# conf.py
+	from sphinx_pyproject import SphinxConfig
+
+	from myproject import __version__ as myproject_version
+
+	config = SphinxConfig("../pyproject.toml", globalns=globals(), config_overrides = {"version": myproject_version})
+
 
 Configuration
 ^^^^^^^^^^^^^^^

sphinx_pyproject/__init__.py

@@ -58,7 +58,11 @@ class SphinxConfig(Mapping[str, Any]):
 	:no-default globalns:
 	:param style: Either ``pep621`` (default), or ``poetry`` to read configuration from the ``[tool.poetry]`` table.
 	:no-default style:
-
+	:param config_overrides: Custom configuration overrides.
+		This parameter can be used to dynamically update values from ``pyproject.toml``.
+		This can be used to patch dynamic values like ``version``.
+		By default, or if explicitly :py:obj:`None`, no config updates are performed.
+	:no-default config_overrides:
 
 	.. autosummary-widths:: 1/4
 	"""
@@ -127,6 +131,7 @@ def __init__(
 			*,
 			globalns: Optional[MutableMapping] = None,
 			style: str = "pep621",
+			config_overrides: Optional[MutableMapping] = None,
 			):
 
 		pyproject_file = PathPlus(pyproject_file).abspath()
@@ -140,6 +145,9 @@ def __init__(
 		namespace = parser_cls.get_namespace(pyproject_file, config)
 		pep621_config = parser_cls().parse(namespace)
 
+		for key, value in (config_overrides or {}).items():
+			pep621_config[key] = value
+
 		for key in ("name", "version", "description"):
 			if key not in pep621_config:
 				raise BadConfigError(

tests/test_sphinx_pyproject.py

@@ -208,3 +208,15 @@ def test_invalid_style(tmp_pathplus: PathPlus):
 	err = "'style' argument must be one of: pep621, poetry"
 	with pytest.raises(ValueError, match=err):
 		SphinxConfig(tmp_pathplus / "pyproject.toml", style="other")
+
+
+def test_config_overrides(tmp_pathplus: PathPlus):
+	(tmp_pathplus / "pyproject.toml").write_text(MINIMUM)
+	config_overrides: Dict[str, Any] = {"version": "3.2.1"}
+
+	config = SphinxConfig(tmp_pathplus / "pyproject.toml", config_overrides=config_overrides)
+
+	assert config.name == "foo"
+	assert config.author == "Dominic Davis-Foster"
+	assert config.version == "3.2.1"
+	assert config.description == "Description"