Allow searching for requirements in multiple directories.

Author: domdfcoding

seed_intersphinx_mapping/extension.py

@@ -5,7 +5,7 @@
 Sphinx-specific functionality.
 """
 #
-#  Copyright (c) 2020 Dominic Davis-Foster <[email protected]>
+#  Copyright © 2020 Dominic Davis-Foster <[email protected]>
 #
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
 #  of this software and associated documentation files (the "Software"), to deal
@@ -34,22 +34,25 @@
 # 3rd party
 from sphinx.application import Sphinx
 from sphinx.config import Config
-from sphinx.environment import BuildEnvironment
 
 # this package
-from seed_intersphinx_mapping.cache import cache
-from seed_intersphinx_mapping.core import get_sphinx_doc_url, seed_intersphinx_mapping
+from seed_intersphinx_mapping.core import seed_intersphinx_mapping
 
-__all__ = ["sphinx_seed_intersphinx_mapping", "sphinx_purge_cache", "setup"]
+__all__ = ["sphinx_seed_intersphinx_mapping", "setup"]
 
 
 def sphinx_seed_intersphinx_mapping(app: Sphinx, config: Config) -> None:
 	"""
 	Updates the ``intersphinx_mapping`` dictionary in the sphinx configuration
-	to include the documentation for the projects listed in the ``requirements.txt`` file.
+	to include the documentation for the project's requirements.
 
-	The ``requirements.txt`` file is found in the directory given by the ``repository_root`` option
-	given in the Sphinx configuration file.
+	If :confval:`pkg_requirements_source` is a list, it is taken to be a list of directories
+	in which to search for ``requirements.txt`` files. Any files found will be used to compile
+	the list of requirements.
+
+	Otherwise, if :confval:`pkg_requirements_source` is the string ``requirements``,
+	the list of requirements will be determined from the ``requirements.txt`` file
+	in the  directory given by the :confval:`repository_root` option.
 
 	:param app:
 	:param config:
@@ -61,6 +64,12 @@ def sphinx_seed_intersphinx_mapping(app: Sphinx, config: Config) -> None:
 	if config.pkg_requirements_source == "requirements":
 		for name, (uri, inv) in seed_intersphinx_mapping(repo_root).items():
 			config.intersphinx_mapping[name] = (name, (uri, (inv, )))
+
+	elif isinstance(config.pkg_requirements_source, list):
+		for directory in config.pkg_requirements_source:
+			for name, (uri, inv) in seed_intersphinx_mapping(repo_root / directory).items():
+				config.intersphinx_mapping[name] = (name, (uri, (inv, )))
+
 	else:  # pragma: no cover
 		raise NotImplementedError(f"Unsupported requirements source '{config.pkg_requirements_source}'")
 
@@ -81,7 +90,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
 	# this package
 	from seed_intersphinx_mapping import __version__
 
-	# Currently, only "requirements"
+	# Currently, only "requirements" or a list of directories containing requirements.txt files relative to the repository root,
 	app.add_config_value("pkg_requirements_source", "requirements", "html")
 
 	# Location of repository directory relative to documentation source directory