From 1724f283ca511c5bcecd853d47520361532bd18b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@henrietta.com.pl>
Date: Mon, 29 Mar 2021 13:49:42 +0200
Subject: [PATCH] added what's snakehouse and contrib guide
---
docs/index.rst | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/docs/index.rst b/docs/index.rst
index 4cb56d4..f32e195 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
==================
--
GitLab