diff --git a/auth0/v3/authentication/authorize_client.py b/auth0/v3/authentication/authorize_client.py index eb57bd93..f2bb4cb5 100644 --- a/auth0/v3/authentication/authorize_client.py +++ b/auth0/v3/authentication/authorize_client.py @@ -28,5 +28,5 @@ def authorize(self, client_id, audience=None, state=None, redirect_uri=None, } return self.get( - 'https://%s/authorize' % self.domain, + 'https://{}/authorize'.format(self.domain), params=params) diff --git a/auth0/v3/authentication/database.py b/auth0/v3/authentication/database.py index da017ab6..48aad9d9 100644 --- a/auth0/v3/authentication/database.py +++ b/auth0/v3/authentication/database.py @@ -25,7 +25,7 @@ def login(self, client_id, username, password, connection, id_token=None, """ warnings.warn("/oauth/ro will be deprecated in future releases", DeprecationWarning) return self.post( - 'https://%s/oauth/ro' % self.domain, + 'https://{}/oauth/ro'.format(self.domain), data={ 'client_id': client_id, 'username': username, @@ -44,7 +44,7 @@ def signup(self, client_id, email, password, connection): """ return self.post( - 'https://%s/dbconnections/signup' % self.domain, + 'https://{}/dbconnections/signup'.format(self.domain), data={ 'client_id': client_id, 'email': email, @@ -59,7 +59,7 @@ def change_password(self, client_id, email, connection, password=None): """ return self.post( - 'https://%s/dbconnections/change_password' % self.domain, + 'https://{}/dbconnections/change_password'.format(self.domain), data={ 'client_id': client_id, 'email': email, diff --git a/auth0/v3/authentication/delegated.py b/auth0/v3/authentication/delegated.py index f0eec7a9..4a91f79a 100644 --- a/auth0/v3/authentication/delegated.py +++ b/auth0/v3/authentication/delegated.py @@ -39,7 +39,7 @@ def get_token(self, client_id, target, api_type, grant_type, 'have a value') return self.post( - 'https://%s/delegation' % self.domain, + 'https://{}/delegation'.format(self.domain), headers={'Content-Type': 'application/json'}, data=data ) diff --git a/auth0/v3/authentication/enterprise.py b/auth0/v3/authentication/enterprise.py index 2fd87ad9..c3180756 100644 --- a/auth0/v3/authentication/enterprise.py +++ b/auth0/v3/authentication/enterprise.py @@ -26,7 +26,7 @@ def wsfed_metadata(self): """Returns the WS-Federation Metadata. """ - url = 'https://%s/wsfed/FederationMetadata' \ + url = 'https://{}/wsfed/FederationMetadata' \ '/2007-06/FederationMetadata.xml' - return self.get(url=url % self.domain) + return self.get(url=url.format(self.domain)) diff --git a/auth0/v3/authentication/get_token.py b/auth0/v3/authentication/get_token.py index 9d2179a7..4064e767 100644 --- a/auth0/v3/authentication/get_token.py +++ b/auth0/v3/authentication/get_token.py @@ -38,7 +38,7 @@ def authorization_code(self, client_id, client_secret, code, """ return self.post( - 'https://%s/oauth/token' % self.domain, + 'https://{}/oauth/token'.format(self.domain), data={ 'client_id': client_id, 'client_secret': client_secret, @@ -75,7 +75,7 @@ def authorization_code_pkce(self, client_id, code_verifier, code, """ return self.post( - 'https://%s/oauth/token' % self.domain, + 'https://{}/oauth/token'.format(self.domain), data={ 'client_id': client_id, 'code_verifier': code_verifier, @@ -110,7 +110,7 @@ def client_credentials(self, client_id, client_secret, audience, """ return self.post( - 'https://%s/oauth/token' % self.domain, + 'https://{}/oauth/token'.format(self.domain), data={ 'client_id': client_id, 'client_secret': client_secret, @@ -157,7 +157,7 @@ def login(self, client_id, client_secret, username, password, scope, realm, """ return self.post( - 'https://%s/oauth/token' % self.domain, + 'https://{}/oauth/token'.format(self.domain), data={ 'client_id': client_id, 'username': username, @@ -191,7 +191,7 @@ def refresh_token(self, client_id, client_secret, refresh_token, grant_type='ref """ return self.post( - 'https://%s/oauth/token' % self.domain, + 'https://{}/oauth/token'.format(self.domain), data={ 'client_id': client_id, 'client_secret': client_secret, diff --git a/auth0/v3/authentication/passwordless.py b/auth0/v3/authentication/passwordless.py index 91b47388..45434aaa 100644 --- a/auth0/v3/authentication/passwordless.py +++ b/auth0/v3/authentication/passwordless.py @@ -37,7 +37,7 @@ def email(self, client_id, email, send='link', auth_params=None): """ return self.post( - 'https://%s/passwordless/start' % self.domain, + 'https://{}/passwordless/start'.format(self.domain), data={ 'client_id': client_id, 'connection': 'email', @@ -53,7 +53,7 @@ def sms(self, client_id, phone_number): """ return self.post( - 'https://%s/passwordless/start' % self.domain, + 'https://{}/passwordless/start'.format(self.domain), data={ 'client_id': client_id, 'connection': 'sms', @@ -67,7 +67,7 @@ def sms_login(self, client_id, phone_number, code, scope='openid'): """ return self.post( - 'https://%s/oauth/ro' % self.domain, + 'https://{}/oauth/ro'.format(self.domain), data={ 'client_id': client_id, 'connection': 'sms', diff --git a/auth0/v3/authentication/social.py b/auth0/v3/authentication/social.py index 4f612897..a4c044b1 100644 --- a/auth0/v3/authentication/social.py +++ b/auth0/v3/authentication/social.py @@ -32,7 +32,7 @@ def login(self, client_id, access_token, connection, scope='openid'): """ return self.post( - 'https://%s/oauth/access_token' % self.domain, + 'https://{}/oauth/access_token'.format(self.domain), data={ 'client_id': client_id, 'access_token': access_token, diff --git a/auth0/v3/authentication/users.py b/auth0/v3/authentication/users.py index 1df6b24f..3594779b 100644 --- a/auth0/v3/authentication/users.py +++ b/auth0/v3/authentication/users.py @@ -26,8 +26,8 @@ def userinfo(self, access_token): """ return self.get( - url='https://%s/userinfo' % self.domain, - headers={'Authorization': 'Bearer %s' % access_token} + url='https://{}/userinfo'.format(self.domain), + headers={'Authorization': 'Bearer {}'.format(access_token)} ) def tokeninfo(self, jwt): @@ -46,7 +46,7 @@ def tokeninfo(self, jwt): """ warnings.warn("/tokeninfo will be deprecated in future releases", DeprecationWarning) return self.post( - url='https://%s/tokeninfo' % self.domain, + url='https://{}/tokeninfo'.format(self.domain), data={'id_token': jwt}, headers={'Content-Type': 'application/json'} ) diff --git a/auth0/v3/management/blacklists.py b/auth0/v3/management/blacklists.py index b1aa4d37..534f1909 100644 --- a/auth0/v3/management/blacklists.py +++ b/auth0/v3/management/blacklists.py @@ -2,7 +2,6 @@ class Blacklists(object): - """Auth0 blacklists endpoints Args: @@ -15,7 +14,7 @@ class Blacklists(object): """ def __init__(self, domain, token, telemetry=True): - self.url = 'https://%s/api/v2/blacklists/tokens' % domain + self.url = 'https://{}/api/v2/blacklists/tokens'.format(domain) self.client = RestClient(jwt=token, telemetry=telemetry) def get(self, aud=None): diff --git a/auth0/v3/management/client_grants.py b/auth0/v3/management/client_grants.py index 6b370154..431e4dcc 100644 --- a/auth0/v3/management/client_grants.py +++ b/auth0/v3/management/client_grants.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/client-grants' % self.domain + url = 'https://{}/api/v2/client-grants'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def all(self, audience=None, page=None, per_page=None, include_totals=False): diff --git a/auth0/v3/management/clients.py b/auth0/v3/management/clients.py index 93ae8699..60db7a9f 100644 --- a/auth0/v3/management/clients.py +++ b/auth0/v3/management/clients.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/clients' % self.domain + url = 'https://{}/api/v2/clients'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def all(self, fields=None, include_fields=True, page=None, per_page=None, extra_params=None): diff --git a/auth0/v3/management/connections.py b/auth0/v3/management/connections.py index 483fe0e6..2e2db1c5 100644 --- a/auth0/v3/management/connections.py +++ b/auth0/v3/management/connections.py @@ -18,9 +18,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/connections' % self.domain + url = 'https://{}/api/v2/connections'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def all(self, strategy=None, fields=None, include_fields=True, page=None, per_page=None, extra_params=None): @@ -139,4 +139,3 @@ def delete_user_by_email(self, id, email): An empty dict. """ return self.client.delete(self._url(id) + '/users', params={'email': email}) - diff --git a/auth0/v3/management/device_credentials.py b/auth0/v3/management/device_credentials.py index d85a672c..516a70ac 100644 --- a/auth0/v3/management/device_credentials.py +++ b/auth0/v3/management/device_credentials.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/device-credentials' % self.domain + url = 'https://{}/api/v2/device-credentials'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def get(self, user_id, client_id, type, fields=None, include_fields=True): diff --git a/auth0/v3/management/email_templates.py b/auth0/v3/management/email_templates.py index 49e7fc8b..365b4d98 100644 --- a/auth0/v3/management/email_templates.py +++ b/auth0/v3/management/email_templates.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/email-templates' % self.domain + url = 'https://{}/api/v2/email-templates'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def create(self, body): diff --git a/auth0/v3/management/emails.py b/auth0/v3/management/emails.py index 0b1aae59..e709846b 100644 --- a/auth0/v3/management/emails.py +++ b/auth0/v3/management/emails.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/emails/provider' % self.domain + url = 'https://{}/api/v2/emails/provider'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def get(self, fields=None, include_fields=True): diff --git a/auth0/v3/management/guardian.py b/auth0/v3/management/guardian.py index ab94d5b9..e421b4b7 100644 --- a/auth0/v3/management/guardian.py +++ b/auth0/v3/management/guardian.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/guardian' % self.domain + url = 'https://{}/api/v2/guardian'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def all_factors(self): @@ -42,7 +42,7 @@ def update_factor(self, name, body): body (dict): Attributes to modify. See: https://auth0.com/docs/api/management/v2#!/Guardian/put_factors_by_name """ - url = self._url('factors/%s' % (name)) + url = self._url('factors/{}'.format(name)) return self.client.put(url, data=body) def update_templates(self, body): @@ -79,7 +79,7 @@ def get_enrollment(self, id): See: https://auth0.com/docs/api/management/v2#!/Guardian/get_enrollments_by_id """ - url = self._url('enrollments/%s' % (id)) + url = self._url('enrollments/{}'.format(id)) return self.client.get(url) def delete_enrollment(self, id): @@ -93,7 +93,7 @@ def delete_enrollment(self, id): See: https://auth0.com/docs/api/management/v2#!/Guardian/delete_enrollments_by_id """ - url = self._url('enrollments/%s' % (id)) + url = self._url('enrollments/{}'.format(id)) return self.client.delete(url) def create_enrollment_ticket(self, body): diff --git a/auth0/v3/management/jobs.py b/auth0/v3/management/jobs.py index c88cf999..c06f3db4 100644 --- a/auth0/v3/management/jobs.py +++ b/auth0/v3/management/jobs.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, path=None): - url = 'https://%s/api/v2/jobs' % self.domain + url = 'https://{}/api/v2/jobs'.format(self.domain) if path is not None: - return url + '/' + path + return '{}/{}'.format(url, path) return url def get(self, id): @@ -42,7 +42,7 @@ def get_failed_job(self, id): See: https://auth0.com/docs/api/management/v2#!/Jobs/get_errors """ - url = self._url('%s/errors' % (id)) + url = self._url('{}/errors'.format(id)) return self.client.get(url) def export_users(self, body): diff --git a/auth0/v3/management/logs.py b/auth0/v3/management/logs.py index 46cf572a..d7b70288 100644 --- a/auth0/v3/management/logs.py +++ b/auth0/v3/management/logs.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/logs' % self.domain + url = 'https://{}/api/v2/logs'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def search(self, page=0, per_page=50, sort=None, q=None, diff --git a/auth0/v3/management/resource_servers.py b/auth0/v3/management/resource_servers.py index 33f87054..90a6be7b 100644 --- a/auth0/v3/management/resource_servers.py +++ b/auth0/v3/management/resource_servers.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/resource-servers' % self.domain + url = 'https://{}/api/v2/resource-servers'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def create(self, body): diff --git a/auth0/v3/management/rest.py b/auth0/v3/management/rest.py index 9f87614a..cca81c37 100644 --- a/auth0/v3/management/rest.py +++ b/auth0/v3/management/rest.py @@ -37,7 +37,7 @@ def __init__(self, jwt, telemetry=True): }).encode('utf-8') self.base_headers = { - 'User-Agent': 'Python/%s' % py_version, + 'User-Agent': 'Python/{}'.format(py_version), 'Auth0-Client': base64.b64encode(auth0_client), 'Content-Type': 'application/json' } @@ -47,7 +47,7 @@ def __init__(self, jwt, telemetry=True): def get(self, url, params=None): headers = self.base_headers.copy() headers.update({ - 'Authorization': 'Bearer %s' % self.jwt, + 'Authorization': 'Bearer {}'.format(self.jwt), }) response = requests.get(url, params=params, headers=headers) @@ -56,7 +56,7 @@ def get(self, url, params=None): def post(self, url, data=None): headers = self.base_headers.copy() headers.update({ - 'Authorization': 'Bearer %s' % self.jwt, + 'Authorization': 'Bearer {}'.format(self.jwt), 'Content-Type': 'application/json' }) @@ -67,7 +67,7 @@ def file_post(self, url, data=None, files=None): headers = self.base_headers.copy() headers.pop('Content-Type', None) headers.update({ - 'Authorization': 'Bearer %s' % self.jwt, + 'Authorization': 'Bearer {}'.format(self.jwt), }) response = requests.post(url, data=data, files=files, headers=headers) @@ -76,7 +76,7 @@ def file_post(self, url, data=None, files=None): def patch(self, url, data=None): headers = self.base_headers.copy() headers.update({ - 'Authorization': 'Bearer %s' % self.jwt, + 'Authorization': 'Bearer {}'.format(self.jwt), 'Content-Type': 'application/json' }) @@ -86,7 +86,7 @@ def patch(self, url, data=None): def put(self, url, data=None): headers = self.base_headers.copy() headers.update({ - 'Authorization': 'Bearer %s' % self.jwt, + 'Authorization': 'Bearer {}'.format(self.jwt), 'Content-Type': 'application/json' }) @@ -96,7 +96,7 @@ def put(self, url, data=None): def delete(self, url, params=None): headers = self.base_headers.copy() headers.update({ - 'Authorization': 'Bearer %s' % self.jwt, + 'Authorization': 'Bearer {}'.format(self.jwt), }) response = requests.delete(url, headers=headers, params=params or {}) diff --git a/auth0/v3/management/rules.py b/auth0/v3/management/rules.py index 1abb208d..5838a65d 100644 --- a/auth0/v3/management/rules.py +++ b/auth0/v3/management/rules.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/rules' % self.domain + url = 'https://{}/api/v2/rules'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def all(self, stage='login_success', enabled=True, fields=None, diff --git a/auth0/v3/management/tenants.py b/auth0/v3/management/tenants.py index 210165d2..b1faef70 100644 --- a/auth0/v3/management/tenants.py +++ b/auth0/v3/management/tenants.py @@ -19,7 +19,7 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self): - return 'https://%s/api/v2/tenants/settings' % self.domain + return 'https://{}/api/v2/tenants/settings'.format(self.domain) def get(self, fields=None, include_fields=True): """Get tenant settings. diff --git a/auth0/v3/management/user_blocks.py b/auth0/v3/management/user_blocks.py index a6b0adb4..82af8e51 100644 --- a/auth0/v3/management/user_blocks.py +++ b/auth0/v3/management/user_blocks.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/user-blocks' % self.domain + url = 'https://{}/api/v2/user-blocks'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def get_by_identifier(self, identifier): diff --git a/auth0/v3/management/users.py b/auth0/v3/management/users.py index 46854b5c..6640e5eb 100644 --- a/auth0/v3/management/users.py +++ b/auth0/v3/management/users.py @@ -19,9 +19,9 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self, id=None): - url = 'https://%s/api/v2/users' % self.domain + url = 'https://{}/api/v2/users'.format(self.domain) if id is not None: - return url + '/' + id + return '{}/{}'.format(url, id) return url def list(self, page=0, per_page=25, sort=None, connection=None, q=None, @@ -166,7 +166,7 @@ def link_user_account(self, user_id, body): body (dict): Please see: https://auth0.com/docs/api/v2#!/Users/post_identities """ - url = self._url('%s/identities' % user_id) + url = self._url('{}/identities'.format(user_id)) return self.client.post(url, data=body) def regenerate_recovery_code(self, user_id): @@ -177,7 +177,7 @@ def regenerate_recovery_code(self, user_id): See: https://auth0.com/docs/api/management/v2#!/Users/post_recovery_code_regeneration """ - url = self._url('%s/recovery-code-regeneration' % user_id) + url = self._url('{}/recovery-code-regeneration'.format(user_id)) return self.client.post(url) def get_guardian_enrollments(self, user_id): @@ -188,7 +188,7 @@ def get_guardian_enrollments(self, user_id): See: https://auth0.com/docs/api/management/v2#!/Users/get_enrollments """ - url = self._url('%s/enrollments' % user_id) + url = self._url('{}/enrollments'.format(user_id)) return self.client.get(url) def get_log_events(self, user_id, page=0, per_page=50, sort=None, @@ -220,5 +220,5 @@ def get_log_events(self, user_id, page=0, per_page=50, sort=None, 'sort': sort } - url = self._url('%s/logs' % user_id) + url = self._url('{}/logs'.format(user_id)) return self.client.get(url, params=params) diff --git a/auth0/v3/management/users_by_email.py b/auth0/v3/management/users_by_email.py index 0c92e6a4..a9759598 100644 --- a/auth0/v3/management/users_by_email.py +++ b/auth0/v3/management/users_by_email.py @@ -19,7 +19,7 @@ def __init__(self, domain, token, telemetry=True): self.client = RestClient(jwt=token, telemetry=telemetry) def _url(self): - url = 'https://%s/api/v2/users-by-email' % self.domain + url = 'https://{}/api/v2/users-by-email'.format(self.domain) return url def search_users_by_email(self, email, fields=None, include_fields=True): diff --git a/docs/conf.py b/docs/conf.py index c1de7cd3..98802d8d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,14 +19,14 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +# sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('../')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -47,7 +47,7 @@ source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' @@ -75,9 +75,9 @@ # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -85,32 +85,31 @@ # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False - # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -120,21 +119,21 @@ # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 @@ -149,62 +148,62 @@ # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' +# html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} +# html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' +# html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. htmlhelp_basename = 'Auth0-Pythondoc' @@ -212,46 +211,46 @@ # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', -# Latex figure (float) alignment -#'figure_align': 'htbp', + # Latex figure (float) alignment + # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'Auth0-Python.tex', u'Auth0 - Python Documentation', - u'Auth0', 'manual'), + (master_doc, 'Auth0-Python.tex', u'Auth0 - Python Documentation', + u'Auth0', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- @@ -264,7 +263,7 @@ ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -273,19 +272,19 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'Auth0-Python', u'Auth0 - Python Documentation', - author, 'Auth0-Python', 'One line description of project.', - 'Miscellaneous'), + (master_doc, 'Auth0-Python', u'Auth0 - Python Documentation', + author, 'Auth0-Python', 'One line description of project.', + 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False