Configuration discovering

Configurations are registred through files (called configuration file) that are loaded as Python modules where some code can register needed configurations.

Discovering will find these configuration files through project and its enabled applications.

Usually you will want to use automatic discovering with the autodiscover function, so you just have to initiate it once from your project (like in your root to load every configuration files.

In some uncommon cases you may need to do discovering yourself from your code, use the discover function to do so.'rstview_configs')[source]

Automatic discovering for available configurations

Before looking at configurations files, registry start from settings.RSTVIEW_PARSER_FILTER_SETTINGS items if setted, else an empty Dict.

Then it try to load possible root configurations file defined in settings.RSTVIEW_PARSER_ROOT_CONFIGS (as a Python path).

And finally load each configurations files finded in settings.INSTALLED_APPS.


from import autodiscover

This is something you want to be executed early in your project, usually the of your project is the best choice.

Keyword Arguments:
 filename (string) – Module filename to search for. Default to rstview_configs, so it will search for a file at root of every enabled module from settings.INSTALLED_APPS.
Returns:List of successfully loaded Python paths.
Return type:list, filename=None)[source]

Try to discover and load a configuration file from given Python path.


Supposing you made a configuration file at myproject/myapp/

from import discover

discover("myproject.myapp", "rstview_configs")
Parameters:module_path (string) – Python path to scan for filename module.
Keyword Arguments:
 filename (string) – Optional module filename to search for, default to None.
Raises:Exception – Raise any occuring exception from loaded Python path.
Returns:Python path (module.filename) for discovered configuration module. If filename does not exists in module, return None.
Return type:string or None