diff --git a/docs/index.rst b/docs/index.rst index 4cb56d43521baed8d85fdbbe83e24300d950bd90..f32e1959148ad614aa2e8ec7ca8bb8b1c2c1904a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,6 +9,16 @@ Welcome to snakehouse's documentation! utilities accelerating +What is snakehouse? +=================== + +Snakehouse_ is a package that helps_ you put multiple :code:`.pyx` files in a single +Python :code:`so`/:code:`DLL`, so that each is importable by Python as if they +were just plain :code:`.py` files. + +.. _helps: https://stackoverflow.com/questions/30157363/collapse-multiple-submodules-to-one-cython-extension + +.. _Snakehouse: https://github.com/smok-serwis/snakehouse Mandatory reading ================= @@ -49,6 +59,17 @@ or Otherwise :code:`PyInit` won't be generated by Cython and such module will be unimportable in Python. Normal import won't suffice. +Contributions +============= + +Contributions are most welcome. Just add yourself to :code:`CONTRIBUTORS.md` list +at your pull request. At this moment most pressing issues are the segfaulting problem, +where snakehouse-built libraries segfault_ the Python interpreter when there's an unhandled +exception (sometimes, I can't really seem to pinpoint the problem source). + +Try to unit test what you're changing, but that is by no way a requirement. + +.. _segfault: https://github.com/smok-serwis/snakehouse/issues/7 Indices and tables ==================