Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Add development/contributor docs

  • Loading branch information...
commit dae5a1e67e25366938422c2f4cbe186aff7abca2 1 parent 6ed4a12
Wouter Bolsterlee authored

Showing 2 changed files with 49 additions and 0 deletions. Show diff stats Hide diff stats

  1. +48 0 doc/developer.rst
  2. +1 0  doc/index.rst
48 doc/developer.rst
Source Rendered
... ... @@ -0,0 +1,48 @@
  1 +===========================
  2 +Contributing and developing
  3 +===========================
  4 +
  5 +.. _Plyvel project page: https://github.com/wbolster/plyvel
  6 +
  7 +
  8 +Reporting issues
  9 +================
  10 +
  11 +Plyvel uses Github's issue tracker. See the `Plyvel project page`_ on Github.
  12 +
  13 +
  14 +Obtaining the source code
  15 +=========================
  16 +
  17 +The Plyvel source code can be found on Github. See the `Plyvel project page`_ on
  18 +Github.
  19 +
  20 +
  21 +Compiling the code
  22 +==================
  23 +
  24 +A simple ``make`` suffices to build the Plyvel extension.
  25 +
  26 +A few remarks about the code:
  27 +
  28 +* Plyvel is mostly written in Cython. The LevelDB API is described in
  29 + `leveldb.pxd`, and subsequently used from Cython.
  30 +
  31 +* The custom comparator support is written in C++ since it contains a C++ class
  32 + that extends a LevelDB C++ class. The Python C API is used for the callbacks
  33 + into Python. This custom class is made available in Cython using
  34 + `comparator.pxd`.
  35 +
  36 +
  37 +Running the tests
  38 +=================
  39 +
  40 +Almost all Plyvel code is covered by the unit tests. Plyvel uses *Nose* for
  41 +running those tests. Type ``make test`` to run the unit tests.
  42 +
  43 +
  44 +Generating the documentation
  45 +============================
  46 +
  47 +The documentation is written in ReStructuredText (ResT) format and processed
  48 +using *Sphinx*. Type ``make doc`` to build the HTML documentation.
1  doc/index.rst
Source Rendered
@@ -47,6 +47,7 @@ Documentation overview
47 47 installation
48 48 user
49 49 api
  50 + developer
50 51 license
51 52
52 53

0 comments on commit dae5a1e

Please sign in to comment.
Something went wrong with that request. Please try again.