/python-local-search

Bash script for searching locally installed Python documentation on Debian-based systems such as Ubuntu

Primary LanguageShellGNU General Public License v2.0GPL-2.0

python-local-search

Bash script for searching locally installed Python documentation on Debian-based systems such as Ubuntu

It is known that Python have a variety of possible documentation formats. For some Python packages it is possible to use Devhelp or DocHelp, for some - not.

This script allows one to run first preliminary full-text search to get Python package name and way to read the relevant documentation in the HTML-format.

It uses aptitude for Python package selection, html2text and/or pandoc packages to run the conversion from HTML to plain-text to get better search results.

The script shows found local HTML documents in default web-browser and provides information about further methods of documentation reading - via DevHelp, DocHelp or web-browser.