shoop.guide package

Submodules

shoop.guide.admin_module module

class shoop.guide.admin_module.GuideAdminModule

Bases: shoop.admin.base.AdminModule

get_search_results(request, query)

shoop.guide.apps module

class shoop.guide.apps.AppConfig(*args, **kwargs)

Bases: shoop.apps.AppConfig

name = 'shoop.guide'

verbose_name = 'Shoop Guide'

provides = {'admin_module': ['shoop.guide.admin_module:GuideAdminModule']}

shoop.guide.settings module

shoop.guide.settings.SHOOP_GUIDE_API_URL = 'https://readthedocs.org/api/v2/search/?project=shoop-guide&version=latest&'

ReadtheDocs API URL

URL for fetching search results via ReadtheDocs API.

shoop.guide.settings.SHOOP_GUIDE_LINK_URL = 'http://shoop-guide.readthedocs.io/en/latest/search.html?check_keywords=yes&area=default&'

ReadtheDocs link URL

URL for manually linking search query link. Query parameters are added to end of URL when constructing link.

shoop.guide.settings.SHOOP_GUIDE_FETCH_RESULTS = True

Whether or not to fetch search results from ReadtheDocs

If true, fetch results via the ReadtheDocs API, otherwise only display a link to RTD search page.

shoop.guide.settings.SHOOP_GUIDE_TIMEOUT_LIMIT = 2

Timeout limit for fetching search results

Time limit in seconds before a search result request should timeout, so as not to block search results in case of slow response.

Module contents