Commit 2361b7ca authored by Moritz Lipp's avatar Moritz Lipp

Update doc

parent fde2cda6
stages:
- build
- test
- doc
# Archlinux
build:archlinux:
......@@ -32,6 +33,22 @@ test:archlinux:
except:
- tags
# Documentation
doc:archlinux:
tags:
- pwmt
stage: doc
image: registry.pwmt.org/pwmt/gitlab-runner-images/archlinux:latest
script:
- cd build
- ninja doc/html
- mv doc/html ../public/
dependencies:
- build:archlinux
artifacts:
paths:
- public
# Debian 10 (Buster)
build:debian-buster:
tags:
......
......@@ -12,7 +12,6 @@ manipulate with the mouse. There are three types of button fields:
* Radio button fields contain a set of related buttons that can each be on or
off. Typically, at most one radio button in a set may be on at any given
time, and selecting any one of the buttons automatically deselects all the
others.
others.
.. c:autodoc:: libzathura/form-fields/form-field-button.h
Contributing
============
Development is coordinated entirely via the `issue tracker
<https://bugs.pwmt.org>`_, our `IRC channel <irc://irc.oftc.net/#pwmt>`_ and our
`mailing list <https://lists.pwmt.org>`_. You can send patches to libzathura's
mailing list, but pull requests on `github <https://github.com/pwmt/libzathura>`_
are preferred.
Development is coordinated entirely via the `issue tracker <https://git.pwmt.org>`_ or our `IRC channel <irc://irc.oftc.net/#pwmt>`_.
You can send patches to via email, but pull requests on our `gitlab <https://git.pwmt.org/pwmt/libzathura>`_
or on `github <https://github.com/pwmt/libzathura>`_ are preferred.
Here are a few more things you should know and check before you send pull
requests:
......
......@@ -13,6 +13,8 @@ a full list of the dependencies here:
* `libfiu <http://blitiri.com.ar/p/libfiu>`_ >= 0.91
* `python-docutils <http://docutils.sourceforge.net>`_
* `python-sphinx <http://sphinx-doc.org>`_
* `meson <http://mesonbuild.com>`_ >= 0.48
* `ninja <http://ninja-build.com>`_
Stable version
--------------
......@@ -23,28 +25,30 @@ Stable version
Since libzathura packages are available for many distributions it is recommended
to use them by installing them with your prefered package manager. Otherwise you
can grab the latest version of the source code from our website and build it by
hand:
can get the latest version of the source code from our website and build it by
manually:
.. code-block:: sh
tar xfv libzathura-<version>.tar.gz
cd libzathura-<version>
make
make install
mkdir -p build && cd build
meson ..
ninja install
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:
features that we are working on, type in the following commands:
.. code-block:: sh
git clone git://pwmt.org/libzathura.git
cd libzathura
git checkout --track -b develop origin/develop
make
make install
mkdir -p build && cd build
meson ..
ninja install
For the installation of a file type plugin check the :ref:`plugins` section.
Sphinx==2.1.0
Sphinx==2.3.1
sphinx-rtd-theme==0.4.3
git+https://github.com/jnikula/hawkmoth@master
clang==6.0.0.2
......@@ -65,7 +65,7 @@ flags = cc.get_supported_arguments(flags)
# optional dependencies
cairo = dependency('cairo', required: get_option('enable-cairo'))
magic = cc.find_library('magic', required: get_option('enable-magic')) #fixme
libfiu = dependency('libfiu', required: get_option('enable-libfiu'))
libfiu = dependency('libfiu', version: '>=0.91', required: get_option('enable-libfiu'))
if magic.found()
build_dependencies += magic
......
subdir('plugin')
check = dependency('check', required: get_option('tests'))
check = dependency('check', version: '>=0.9.8', required: get_option('tests'))
if check.found()
test_dependencies = [
declare_dependency(link_with: libzathura),
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment