diff --git a/doc/conf.py b/doc/conf.py index 763487d..fbb8c52 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -35,7 +35,7 @@ htmlhelp_basename = 'zathuradoc' # -- Options for manual page output --------------------------------------- man_pages = [ - ('index', 'zathura', 'zathura Documentation', ['pwmt.org'], 1) + ('manpage', 'zathura', 'a document viewer', ['pwmt.org'], 1) ] diff --git a/doc/index.rst b/doc/index.rst index 025df07..3b090a6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -16,10 +16,7 @@ Welcome to zathura's documentation! api/index faq -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +.. toctree:: + :hidden: + manpage diff --git a/doc/installation/index.rst b/doc/installation/index.rst index 11e4437..a0f9a9d 100644 --- a/doc/installation/index.rst +++ b/doc/installation/index.rst @@ -1,2 +1,87 @@ Installation ============ + +Dependencies +------------ + +The core of zathura depends on two external libraries, +`girara `_, our simplistic user interface library and +`GTK+ `_, a cross-platform widget toolkit. +Depending on which filetypes should be supported you are going to need +additional libraries to build those file type plugins. + +Core dependencies +~~~~~~~~~~~~~~~~~ + +- `girara `_, our simplistic user interface library + (>= 0.1.8) +- `GTK+ `_, a cross-platform widget toolkit (>= + 2.28) + +Optional and build dependencies +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- `sqlite3 `_, a SQL database engine +- `intltool `_, utility scripts for + internationalization +- `check `_, a unit testing framework + for C +- libmagic from `file `_, a file type + guesser +- `docutils `_, documentation + utilities + +Stable version +-------------- + +Since zathura packages are available in many distributions it is +recommended to install it from there with your prefered package manager. +Otherwise you can grab the latest version of the source code from our +website and build it by hand: + +:: + + $ tar xfv zathura-.tar.gz + $ cd zathura- + $ make + $ make install + +Known supported distributions +----------------------------- + +- `Arch + Linux `_ +- `Debian `_ +- `Fedora `_ +- `Gentoo `_ +- `Ubuntu `_ +- `OpenBSD `_ + +Developer version +----------------- + +If you are interested in testing the very latest versions with all its +new features, that we are working on, type in the following commands. At +first you have to install the latest version of girara: + +:: + + $ git clone git://pwmt.org/girara.git + $ cd girara + $ git checkout --track -b develop origin/develop + $ make + $ make install + +After the successful installation of the user interface library, grab +the latest version of zathura and install it: + +:: + + $ git clone git://pwmt.org/zathura.git + $ cd zathura + $ git checkout --track -b develop origin/develop + $ make + $ make install + +For the installation of a file type plugin check the +`plugins <../plugins>`_ section. diff --git a/doc/manpage.rst b/doc/manpage.rst new file mode 100644 index 0000000..90235c5 --- /dev/null +++ b/doc/manpage.rst @@ -0,0 +1,15 @@ +Manpage +======= + +Synopsis +-------- + +Description +----------- + +Usage +----- + +See Also +-------- +:manpage:`zathurarc(5)`