Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
pwmt
zathura
Commits
b86a1716
Commit
b86a1716
authored
Apr 27, 2014
by
Sebastian Ramacher
Browse files
Some more documentation
Signed-off-by:
Sebastian Ramacher
<
sebastian+dev@ramacher.at
>
parent
411089b2
Changes
2
Hide whitespace changes
Inline
Side-by-side
README
View file @
b86a1716
...
...
@@ -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.
...
...
doc/Makefile
View file @
b86a1716
...
...
@@ -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
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment