mirrors/zathura
1
0
Fork 0
mirror of https://git.pwmt.org/pwmt/zathura.git synced 2025-01-15 09:46:01 +01:00
Code Issues Projects Releases Packages Wiki Activity

Some more documentation

Browse source 
Signed-off-by: Sebastian Ramacher <sebastian+dev@ramacher.at>
This commit is contained in:
Sebastian Ramacher 2014-04-27 14:39:10 +02:00
parent 411089b2ae
commit b86a17164c
2 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README
View file

@ -11,16 +11,20 @@ girara (>= 0.1.8)
sqlite3 (optional, >= 3.5.9) sqlite3 (optional, >= 3.5.9)
check (for tests) check (for tests)
intltool intltool
python-docutils (optional, for man pages)
libmagic from file(1) (optional, for mime-type detection) libmagic from file(1) (optional, for mime-type detection)
Sphinx (optional, for manpages and HTML documentation)
doxygen (optional, for HTML documentation)
breathe (optional, for HTML documentation)
sphinx_rtd_theme (optional, for HTML documentation)
Please note that you need to have a working pkg-config installation and that the Please note that you need to have a working pkg-config installation and that the
Makefile is only compatible with GNU make. If you don't have a working Makefile is only compatible with GNU make. If you don't have a working
pkg-config installation please set the GTK_INC, GTK_LIB, GIRARA_INC, GIRARA_LIB, pkg-config installation please set the GTK_INC, GTK_LIB, GIRARA_INC, GIRARA_LIB,
SQLITE_INC and SQLITE_LIB variables accordingly. SQLITE_INC and SQLITE_LIB variables accordingly.
And also note that rst2man from python-docutils is needed to build the man pages. Also note that Sphinx is needed to build the manpages. If it is not
If it is not installed, the man pages won't be built. installed, the man pages won't be built. For the HTML documentation, doxygen,
breathe and sphinx_rtd_theme are needed in additioan to Sphinx.
If you don't want to build with support for sqlite databases, you can set If you don't want to build with support for sqlite databases, you can set
WITH_SQLITE=0 and sqlite support won't be available. WITH_SQLITE=0 and sqlite support won't be available.

7
doc/Makefile
View file

@ -40,15 +40,12 @@ html:
else else
man: $(SPHINX_BUILDDIR)/zathura.1 $(SPHINX_BUILDDIR)/zathurarc.5 man: $(SPHINX_BUILDDIR)/zathura.1 $(SPHINX_BUILDDIR)/zathurarc.5
ifeq ($(shell which $(DOXYGEN_BIN) >/dev/null 2>&1; echo $$?), 0) # TODO: Make a better test for breathe and sphinx_rtd_theme
ifeq ($(shell $(PYTHON_BIN) -c "import breathe; import sphinx_rtd_theme" >/dev/null 2>&1; echo $$?), 0) ifeq ($(shell which $(DOXYGEN_BIN) >/dev/null 2>&1 && $(PYTHON_BIN) -c "import breathe; import sphinx_rtd_theme" >/dev/null 2>&1; echo $$?), 0)
html: $(SPHINX_BUILDDIR)/html/index.html html: $(SPHINX_BUILDDIR)/html/index.html
else else
html: html:
endif endif
else
html:
endif
endif endif
.PHONY: clean html man all .PHONY: clean html man all