ansys.tools.meilisearch.templates.utils#

Templates utilities module.

Functions#

get_template(→ str)

Get the template name for a web page.

get_redirected_url(html)

Get the URL that a web page is being redirected to.

is_sphinx(url)

Determine if a web page was built using Sphinx.

Module Contents#

ansys.tools.meilisearch.templates.utils.get_template(url: str) str#

Get the template name for a web page.

Parameters:
urlstr

URL of the web page.

Returns:
str

Template name for the web page.

ansys.tools.meilisearch.templates.utils.get_redirected_url(html)#

Get the URL that a web page is being redirected to.

Parameters:
htmlstr

Web page to search for a redirected URL.

Returns:
str or None

URL that the page is being redirected to. If no redirection is present, None is returned.

ansys.tools.meilisearch.templates.utils.is_sphinx(url)#

Determine if a web page was built using Sphinx.

Parameters:
urlstr

URL of the web page.

Returns:
bool

True if the page was built using Sphinx, False otherwise.