How to compile newest version of devhelp in Ubuntu 15.04 64-bit using devhelp sources on github

Posted: 2014/01/26 in Ubuntu
Tags: , , , , , ,

How to compile newest version of devhelp in Ubuntu 15.04 64-bit using devhelp sources on github
================================================================================================

Prerequisite: Ubuntu 15.04 or newer

#remove any old install of devhelp
cd
rm -rf devhelp
sudo apt-get remove devhelp
# install newer version of devhelp
sudo apt-get update
sudo apt-get install gnome-common libwebkit2gtk-3.0-dev cdbs dh-translations gnome-pkg-tools libpython3-dev libpython3.3-dev libwebkit2gtk-3.0-dev libwebkit2gtk-3.0-25 python-scour python3-dev python3.3-dev libgconfmm-2.6-dev
sudo add-apt-repository ppa:gnome3-team/gnome3
sudo apt-get update
sudo apt-get build-dep devhelp
git clone https://github.com/GNOME/devhelp.git
cd devhelp
./autogen.sh
sudo make
sudo make install

Close all Terminal windows.

Open new Terminal window.

Check version of devhelp using this command:

devhelp -v

Devhelp extra information
===========================

Devhelp’s primary goal is to be an API documentation browser for
GNOME. When you build (or install) a GNOME library, it will build an
API reference for you and install it into:

$datadir/gtk-doc/html/$PACKAGE.

Along with the HTML files, a .devhelp and/or .devhelp2 index file is
also generated automatically. Thus Devhelp can simply scan that folder
for those index files and display the books they represent.

Devhelp uses the “XDG Base Directory Specification” to find
documentation. You can read more about that specification here:

http://standards.freedesktop.org/basedir-spec/latest/

The list of locations searched for devhelp books is:

$XDG_DATA_HOME/devhelp/books
e.g. /home/ross/.local/share/devhelp/books/glib-2.0/glib-2.0.devhelp

$XDG_DATA_HOME/gtk-doc/html
e.g. /home/ross/.local/share/gtk-doc/html/glib-2.0/glib-2.0.devhelp

$XDG_DATA_DIRS/devhelp/books
e.g. /usr/local/share/devhelp/books/glib-2.0/glib-2.0.devhelp

$XDG_DATA_DIRS/gtk-doc/html
e.g. /usr/local/share/gtk-doc/html/glib-2.0/glib-2.0.devhelp

Note that the two latter consist of: separated lists of directories to
look for. Those environment variables are normally set up by the
desktop environment or distribution.

Note that the name of the directory the .devhelp file is in and the
name of the .devhelp file (minus the extension) must match.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s