Fix oidc_paths_prefix documentation and usage

Author: gbip

django_pyoidc/settings.py

@@ -165,8 +165,12 @@ def _fix_settings(self, op_definition: Dict[str, Any]) -> Dict[str, Any]:
             # is a better way to define callback path.
             # here this will only work when no route prefix is used.
 
+            op_definition["oidc_paths_prefix"] = op_definition[
+                "oidc_paths_prefix"
+            ].lstrip("/")
+
             if "oidc_callback_path" not in op_definition:
-                op_definition["oidc_callback_path"] = reverse_lazy(
+                op_definition["oidc_callback_path"] = (
                     f"{op_definition['oidc_paths_prefix']}-callback"
                 )
 

docs/settings.rst

@@ -73,12 +73,15 @@ oidc_paths_prefix
 
 **Default** : dynamically computed using the name of your identity provider.
 
-This is the prefix of the various url names created by the OIDCHelper when using get_urlpatterns. If not set it defaults to the op_name.
+This is the prefix of the various url names created *automagically* by the OIDCHelper (when using get_urlpatterns). If not set it defaults to the op_name.
 
 .. note::
-    One of the created paths is the one referenced by the setting ``oidc_callback_path``.
+    One of the URL is the one referenced by the setting ``oidc_callback_path``.
 
-You can use this setting to change how the OIDC views are named. By default they are named ``<op_name>_[login|callback]``.
+.. warning::
+    If your prefix starts with a ``/`` it will be removed.
+
+You can use this setting to change the prefix used to name the URLs generated by this library. By default the URLS are named ``<op_name>-[login|callback|logout|etc.]``.
 
 Configuring this setting allows you to swap ``<op_name>`` with an other value.
 

run_tests.py

@@ -7,7 +7,7 @@
 from django.test.utils import get_runner
 
 if __name__ == "__main__":
-    os.environ["DJANGO_SETTINGS_MODULE"] = "tests.test_settings"
+    os.environ["DJANGO_SETTINGS_MODULE"] = "tests.settings"
     django.setup()
     TestRunner = get_runner(settings)
     test_runner = TestRunner()