GithubHelp home page GithubHelp logo

rohitsroch / xapian-docsprint Goto Github PK

View Code? Open in Web Editor NEW

This project forked from xapian/xapian-docsprint

0.0 1.0 0.0 826 KB

The user manual for Xapian.

Home Page: https://xapian.org/

License: Other

Makefile 1.76% C++ 24.68% Java 3.79% PHP 9.75% Python 60.02%

xapian-docsprint's Introduction

Xapian documentation sprint

We're writing new introductory documentation for Xapian. See the formatted output at https://getting-started-with-xapian.readthedocs.org/

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

This repository will be merged into the main Xapian tree and disappear once ready.

You will need the Sphinx documentation tool installed to process the documentation. Confusingly there are several open source projects called "Sphinx" - see http://sphinx-doc.org/install.html for tips on installing the one you want (installing the python-sphinx package should work on at least Debian, Fedora and Ubuntu). We're unsure of the exact minimum version requirement, but it's at least Sphinx 1.0.0 (the oldest we've tested with at all recently was Sphinx 1.1.3). Either the Python 2 or Python 3 version should work.

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++

xapian-docsprint's People

Contributors

ojwb avatar jaylett avatar rboulton avatar dcolish avatar iamfinky avatar mkash32 avatar parthg avatar gauravaror avatar aarshkshah1992 avatar ivmarkp avatar jorgecarleitao avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.