SlackwareThis Forum is for the discussion of Slackware Linux.
Notices
Welcome to LinuxQuestions.org, a friendly and active Linux Community.
You are currently viewing LQ as a guest. By joining our community you will have the ability to post topics, receive our newsletter, use the advanced search, subscribe to threads and access many other special features. Registration is quick, simple and absolutely free. Join our community today!
Note that registered members see fewer ads, and ContentLink is completely disabled once you log in.
If you have any problems with the registration process or your account login, please contact us. If you need to reset your password, click here.
Having a problem logging in? Please visit this page to clear all LQ-related cookies.
Get a virtual cloud desktop with the Linux distro that you want in less than five minutes with Shells! With over 10 pre-installed distros to choose from, the worry-free installation life is here! Whether you are a digital nomad or just looking for flexibility, Shells can put your Linux machine on the device that you want to use.
Exclusive for LQ members, get up to 45% off per month. Click here for more info.
I see that the Python documentation in /usr/share/doc/python-2.6.6/ is in text format. Is it possible to convert this documentation tree into HTML using any existing tools?
I ask because I wanted to avoid downloading the HTML documentation all over again if possible, since the documents are present in the distribution.
(I normally like to read the HTML documentation as it is nicer to browse through the different pages etc.)
As the documentation is actually in reStructuredText, Sphinx is what's used to generate HTML from it. I haven't used it for Python documentation myself (actually, haven't used it at all for quite some time now), so can't help you here with any detailed instructions, but it shouldn't be hard to use.
I too think HTML docs are nice to have, but I believe Pat omitted it due to size constraints.
@audriusk, thanks. I will check that page. If it is not possible to automate a build, it might be easier to download the Python documentation separately, or I might write a small Python script for this
EDIT: it appears that sphinx is already a script for automating builds. Just not sure how to get it to run on the Python documentation source tree.
Last edited by vharishankar; 11-08-2011 at 09:34 AM.
Hi audriusk, I am sure the Python documentation writers use a custom script to build their documentation in HTML and other sources. These tools have no man pages, so it's a bit difficult to figure out how to specify the source path (whether each sub-directory should be treated as a separate source or not). Rather than experiment now, I think I'll leave it as a future project.
I tried googling on "how to generate python documentation from source" but most of these links end up in pydoc related pages.
I too think HTML docs are nice to have, but I believe Pat omitted it due to size constraints.
Actually, the plain text docs without the hyperlinks are almost useless. I end up going to the python web page instead of attempting to use the bundled documentation. YMMV, but I'd much rather have the html.
If you're only interested in the modules documentation, running "pydoc -p 8080" on a terminal and poiting your browser to http://localhost:8080/ could do the trick.
LinuxQuestions.org is looking for people interested in writing
Editorials, Articles, Reviews, and more. If you'd like to contribute
content, let us know.