Sphinx Doc Bot

A Telegram bot that lets you search Sphinx based documentation. Head here for the user guide. An instance searching the Python docs can be found at @PythonDocBot.

Disclaimers:

This project

• is not officially associated with Sphinx

• does not offer a bot that can search any Sphinx documentation. For the Python docs, the author hosts @PythonDocBot, for everything else you’ll need to set up your own bot.

• is heavily inspired by @roolsbot, which allows to search the docs of python-telegram-bot.

What this project does

Sphinx is an open source documentation generator originally created for the Python documentation and is widely used to document Python packages. This projects allows to deploy a Telegram Bot which can be used to search the documentation of the Sphinx documentation of your choice.

Setting things up

To set up a bot, you only need to install the dependencies via pip install -r requirements.txt and fill the bot.ini configuration file:

• token: your bots token

• admins_chat_id: your Telegram ID. Used to send error reports

• docs_url: The URL where your Sphinx documentation is hosted.

• cache_timeout: The documentation is fetched in a cached manner, i.e. the short URLS are retrieved at most every cache_timeout minutes. Defaults to 60 minutes.

That’s it. Run the bot via python main.py. 🤖