Skip to content
Browse files

Add development/contributor docs

  • Loading branch information...
1 parent 6ed4a12 commit dae5a1e67e25366938422c2f4cbe186aff7abca2 @wbolster committed Nov 26, 2012
Showing with 49 additions and 0 deletions.
  1. +48 −0 doc/developer.rst
  2. +1 −0 doc/index.rst
View
48 doc/developer.rst
@@ -0,0 +1,48 @@
+===========================
+Contributing and developing
+===========================
+
+.. _Plyvel project page: https://github.com/wbolster/plyvel
+
+
+Reporting issues
+================
+
+Plyvel uses Github's issue tracker. See the `Plyvel project page`_ on Github.
+
+
+Obtaining the source code
+=========================
+
+The Plyvel source code can be found on Github. See the `Plyvel project page`_ on
+Github.
+
+
+Compiling the code
+==================
+
+A simple ``make`` suffices to build the Plyvel extension.
+
+A few remarks about the code:
+
+* Plyvel is mostly written in Cython. The LevelDB API is described in
+ `leveldb.pxd`, and subsequently used from Cython.
+
+* The custom comparator support is written in C++ since it contains a C++ class
+ that extends a LevelDB C++ class. The Python C API is used for the callbacks
+ into Python. This custom class is made available in Cython using
+ `comparator.pxd`.
+
+
+Running the tests
+=================
+
+Almost all Plyvel code is covered by the unit tests. Plyvel uses *Nose* for
+running those tests. Type ``make test`` to run the unit tests.
+
+
+Generating the documentation
+============================
+
+The documentation is written in ReStructuredText (ResT) format and processed
+using *Sphinx*. Type ``make doc`` to build the HTML documentation.
View
1 doc/index.rst
@@ -47,6 +47,7 @@ Documentation overview
installation
user
api
+ developer
license

0 comments on commit dae5a1e

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