From b86a17164cc6511046bcfc1ba3705f47e0af8a3b Mon Sep 17 00:00:00 2001 From: Sebastian Ramacher Date: Sun, 27 Apr 2014 14:39:10 +0200 Subject: [PATCH] Some more documentation Signed-off-by: Sebastian Ramacher --- README | 10 +++++++--- doc/Makefile | 7 ++----- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README b/README index fbdb441..8ec5653 100644 --- a/README +++ b/README @@ -11,16 +11,20 @@ girara (>= 0.1.8) sqlite3 (optional, >= 3.5.9) check (for tests) intltool -python-docutils (optional, for man pages) 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 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, SQLITE_INC and SQLITE_LIB variables accordingly. -And also note that rst2man from python-docutils is needed to build the man pages. -If it is not installed, the man pages won't be built. +Also note that Sphinx is needed to build the manpages. If it is not +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 WITH_SQLITE=0 and sqlite support won't be available. diff --git a/doc/Makefile b/doc/Makefile index d9c33ea..7393049 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -40,15 +40,12 @@ html: else man: $(SPHINX_BUILDDIR)/zathura.1 $(SPHINX_BUILDDIR)/zathurarc.5 -ifeq ($(shell which $(DOXYGEN_BIN) >/dev/null 2>&1; echo $$?), 0) -ifeq ($(shell $(PYTHON_BIN) -c "import breathe; import sphinx_rtd_theme" >/dev/null 2>&1; echo $$?), 0) +# TODO: Make a better test for breathe and sphinx_rtd_theme +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 else html: endif -else -html: -endif endif .PHONY: clean html man all