discover_setup_packages#

documenteer.stackdocs.pkgdiscovery.discover_setup_packages(scope=None)#

Summarize packages currently set up by EUPS, listing their set up directories and EUPS version names.

Parameters:

scope (Optional[List[str]], default: None) – Names of packages that are in scope to include in the returned package data. Leave as None if packages should not be filtered.

Returns:

Dictionary with keys that are EUPS package names. Values are dictionaries with fields:

  • 'dir': absolute directory path of the set up package.

  • 'version': EUPS version string for package.

Return type:

packages

Notes

This function imports the eups Python package, which is assumed to be available in the build environmen. This function is designed to encapsulate all direct EUPS interactions need by the stack documentation build process.