Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.17 KB

README.md

File metadata and controls

43 lines (26 loc) · 1.17 KB

The Axiom Book

The Axiom Book is intended as a primer to Axiom, an object store for Python built on top of SQLite.

Reading

The current version of the book is graciously hosted by ReadTheDocs.

Building

The repository is a fairly standard Sphinx repository. To build the documentation, run make [builder] where builder is the format you want (e.g. html or pdf).

The documentation is self-testing using doctests, wich can be run using make doctests.

Contributing

Contributions and issue reports are welcome on Github.

Please make contributions self-testing using doctest wherever possible!

Testing

Most of the Axiom book is written using doctests, so the book can largely be automatically verified. This is done automatically by Travis CI.

Build Status