Skip to content
Snippets Groups Projects
Commit 1724f283 authored by Piotr Maślanka's avatar Piotr Maślanka
Browse files

added what's snakehouse and contrib guide

parent 2d3c6002
No related branches found
No related tags found
No related merge requests found
......@@ -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
==================
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment