Question

1

Do we have offline Python documentation browser in Ubuntu repositories to have one "point of service" to read and search the Python docs and APIs?

rated 0 times [ 1] [ 0] / answers: 1 / hits: 658 / 1 Year ago, sat, may 27, 2023, 8:09:53

The question is in the title. As a use case one can imagine the situation about finding function basing on its known functionality.

I already know about Zeal which is packaged. It downloads documentation sets from Dash project. This is great but the Python versions differ from installed on system. They are usually newer.

The DevHelp application do not know about Python libraries. The search on pydoc3 -p 8080 does not work as expected. KHelpCenter does not know about Python. The doc-central package seems to be broken for long time. dochelp shows only index from /usr/share/doc-help and does not provide full-text search.

What else should I try to have ability for reading and searching Python documentation offline from /usr/share/doc (and similar locations)?

My system reports that I have 467 folders there (ls -1d /usr/share/doc/*python* | wc -l).

Answers

Only authorized users can answer the question. Please sign in first, or register a free account.

gliroopy

Add To Favorites

Follow

Total Points: 290

Total Questions: 115

Total Answers: 114

Location: Egypt

Member since Tue, May 3, 2022

2 Years ago

gliroopy questions

1 Windows 10 and Ubuntu dual boot - sleep/wake issues?

Fri, Apr 21, 23, 18:26, 1 Year ago

1 How to remove netplan.io but keep ethernet

Wed, Apr 19, 23, 09:44, 1 Year ago

1 On Ubuntu 20.4.3 Alt+Left Ctrl do not function as Alt Gr on Finnish layout

Sat, Sep 4, 21, 17:22, 3 Years ago

1 Autostart C++ compiled application upon boot

Wed, Apr 13, 22, 08:49, 2 Years ago

1 How to clear the terminal history from vim?

Mon, Sep 13, 21, 18:25, 3 Years ago

View All

answered 1 Year ago ovierman · Accepted Answer

I have created Bash shell script for searching locally installed Python documentation on Debian-based systems (such as Ubuntu) and placed it at GitHub.

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.