searx.infopage Namespace Reference

Classes
class	InfoPage
class	InfoPageSet

Variables
list	__all__ = ['InfoPage', 'InfoPageSet']
	logger = logging.getLogger('searx.infopage')
	_INFO_FOLDER = os.path.abspath(os.path.dirname(__file__))

Detailed Description

Render SearXNG instance documentation.

Usage in a Flask app route:

.. code:: python

  from searx import infopage

  _INFO_PAGES = infopage.InfoPageSet(infopage.MistletoePage)

  @app.route('/info/<pagename>', methods=['GET'])
  def info(pagename):

      locale = request.preferences.get_value('locale')
      page = _INFO_PAGES.get_page(pagename, locale)

Variable Documentation

__all__

list searx.infopage.__all__ = ['InfoPage', 'InfoPageSet']

private

Definition at line 20 of file __init__.py.

_INFO_FOLDER

searx.infopage._INFO_FOLDER = os.path.abspath(os.path.dirname(__file__))

protected

Definition at line 39 of file __init__.py.

logger

searx.infopage.logger = logging.getLogger('searx.infopage')

Definition at line 38 of file __init__.py.