At the moment the cache folder is hard coded to $HOME/.cache/audbcards when running the sphinx extension. But it would be better if a user has the option to specify the desired location, e.g. as CI runner might only cache folders in a certain location.
This could be achieved in one of the following ways:
Add a audbcards_cache config value to the sphinx extension
Allow to specify a environmental variable AUDBCARDS_CACHE_ROOT to specify the folder
Add a audbcards.config.CACHE_ROOT configuration entry, which a user might set in docs/conf.py (which has the disadvantage that the same cache root has to be used locally and in an CI job)
Add a ~/.audbcards.yaml config file to specify the cache root
At the moment the cache folder is hard coded to
$HOME/.cache/audbcardswhen running the sphinx extension. But it would be better if a user has the option to specify the desired location, e.g. as CI runner might only cache folders in a certain location.This could be achieved in one of the following ways:
audbcards_cacheconfig value to the sphinx extensionAUDBCARDS_CACHE_ROOTto specify the folderaudbcards.config.CACHE_ROOTconfiguration entry, which a user might set indocs/conf.py(which has the disadvantage that the same cache root has to be used locally and in an CI job)~/.audbcards.yamlconfig file to specify the cache root