ansys.tools.meilisearch.templates.utils
=======================================

.. py:module:: ansys.tools.meilisearch.templates.utils

.. autoapi-nested-parse::

   Templates utilities module.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   ansys.tools.meilisearch.templates.utils.get_template
   ansys.tools.meilisearch.templates.utils.get_redirected_url
   ansys.tools.meilisearch.templates.utils.is_sphinx


Module Contents
---------------

.. py:function:: get_template(url: str) -> str

   
   Get the template name for a web page.


   :Parameters:

       **url** : :class:`python:str`
           URL of the web page.

   :Returns:

       :class:`python:str`
           Template name for the web page.













   ..
       !! processed by numpydoc !!

.. py:function:: get_redirected_url(html)

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


   :Parameters:

       **html** : :class:`python:str`
           Web page to search for a redirected URL.

   :Returns:

       :class:`python:str` or :data:`python:None`
           URL that the page is being redirected to. If no redirection
           is present, ``None`` is returned.













   ..
       !! processed by numpydoc !!

.. py:function:: is_sphinx(url)

   
   Determine if a web page was built using Sphinx.


   :Parameters:

       **url** : :class:`python:str`
           URL of the web page.

   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` if the page was built using Sphinx, ``False`` otherwise.













   ..
       !! processed by numpydoc !!