pydox.config_files

Contents

pydox.config_files#

config_files() → list[Path][source]#

Get the list of all available configuration files to build a default configuration

List of all possible files:

  • From factory, ie where pydox is installed, eg:

    • ${HOME}/bin/yes/envs/pydox-dev/lib/python3.11/site-packages/pydox/static/pydoxrc

  • From the user configuration folder, eg:

    • ${PYDOXCONFIGDIR}/pydoxrc or

    • ${XDG_CONFIG_HOME}/pydox/pydoxrc or

    • ${HOME}/.config/pydox/pydoxrc or

    • ${HOME}/.pydox/pydoxrc

  • From the executing environment, ie from the environment variable:

    • ${PYDOXRC} or

    • ${PYDOXRC}/pydoxrc

  • From the current executing path, ie from the environment variable:

    • ${PWD}/pydoxrc

Returns:

A list of absolute paths toward default configuration files. The first file is always the factory configuration file.

Return type:

list[Path]

See also

pydox._config.config.load_configs()

Contents