Skip to content
The user manual for Xapian.
Python C++ Perl PHP Java Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
advanced
attic
code
concepts
data
deprecation
howtos
language_specific
oldmanual
practical_example
.gitignore
LICENSE.rst
Makefile
README.md
conf.py
glossary.rst
index.rst
language_specific.rst
overview.rst
requirements.txt

README.md

Xapian documentation sprint

This is the source for Xapian's user guide. Eventually this repository will be merged into the main Xapian tree.

Join in on channel #xapian on irc.freenode.net (webchat link: https://webchat.freenode.net/?channels=%23xapian) or via our mailing lists.

You will need the Sphinx documentation tool installed to process the documentation. You can install the python-sphinx 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 make help 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.

You can’t perform that action at this time.