Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
snakehouse
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
public
snakehouse
Commits
1724f283
Commit
1724f283
authored
4 years ago
by
Piotr Maślanka
Browse files
Options
Downloads
Patches
Plain Diff
added what's snakehouse and contrib guide
parent
2d3c6002
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/index.rst
+21
-0
21 additions, 0 deletions
docs/index.rst
with
21 additions
and
0 deletions
docs/index.rst
+
21
−
0
View file @
1724f283
...
...
@@ -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
==================
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment