diff --git a/docs/index.rst b/docs/index.rst index 27562f9..49690a2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -60,3 +60,14 @@ API reference >>> attributes["img"].add("data-invert") >>> nh3.clean("", attributes=attributes) '' + +.. attribute:: ALLOWED_URL_SCHEMES + + The default set of URL schemes permitted on ``href`` and ``src`` attributes. + Useful for customizing the default to add or remove some URL schemes: + + .. code-block:: pycon + + >>> url_schemes = nh3.ALLOWED_URL_SCHEMES - {'tel'} + >>> nh3.clean('Call or email me.', url_schemes=url_schemes) + 'Call or email me.'