Xapian documentation sprint
This is the source for Xapian's user guide. Eventually this repository will be merged into the main Xapian tree.
You will need the Sphinx documentation tool
installed to process the documentation. You can install the
package on Debian, Fedora and Ubuntu, or
pip install -r requirements.txt
to install the python package directly. We currently support up to Sphinx
1.8.5, because we have yet to migrate our custom domain to python3.
You can generate versions for different programming languages (with translated
examples and adjustments to the text). For full details see
but for example to generate an HTML version for C++ use:
make html LANGUAGE=c++
The default (when you run just
make html) is to build for python.