Take the 2-minute tour ×
Ask Ubuntu is a question and answer site for Ubuntu users and developers. It's 100% free, no registration required.

I've been using Devhelp but find that it is too much towards python, and Gnome development. Other documentations (such as php-doc) are left out as of now.

Is there a simple way to add php-doc into devhelp ?

share|improve this question

3 Answers 3

up vote 1 down vote accepted

Devhelp requires documentation in specific format (.devhelp files, presumably generated with gtk-doc), it won't automatically pick documentation from all *-doc packages present on your system.

Edit: PHP documentation is still available in /usr/share/doc/php-doc/html once you install php-doc package. However, probably more robust solution is to download PHP documentation in CHM format and use it with some CHM viewer like ChmSee or xCHM.

share|improve this answer
1  
I'll try to port over the php-doc to devhelp. It can't be that difficult, as its already in html which is used by devhelp internally. –  Capt.Nemo Jun 16 '11 at 17:52
    
.devhelp (or .devhelp2) files are basically just TOC of symbols and functions, so this shouldn't be so hard. Good luck! –  jnv Jun 16 '11 at 18:03

I'm using devhelp through synapse for php-docs.

Some nice guy wrote a script to convert .CHM into .TGZ (devhelp) format and to install the files. So it goes like:

  1. Convert:

    hhconvert.py YOUR_DOC.chm YOUR_DOC.tgz
    
  2. Install:

    devhelp-install YOUR_DOC.tgz
    

Note

For the convert script to work you need to install first Python, ctypes, CHMLIB.

Install puts YOUR_BOOK.devhelp and the res-Folder into ~/.local/share/devhelp/books/YOUR_BOOK/.

share|improve this answer

I'm not familiar with devhelp, but I'd assume at least the first step would be to install php-doc. It's in the repos, so a quick apt-get install php-doc will get it for you. I'd venture to guess that from there, either devhelp will pick it up automatically, or there's a setting somewhere that allows you to specify the location of the php-doc executable. If not, there might be a plugin, but my quick search in the repos only shows php-doc plugins for kdevelop, so you'll probably have to do a Google search for that (the PHP-doc website might also be helpful).

The other alternative, of course, is to see if there's a PHP-oriented alternative to Devhelp.

share|improve this answer

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.