Skip to content

Commit

Permalink
Add link to source and license information to the doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
lgautier committed Dec 8, 2024
1 parent 60973b6 commit b4ab286
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 9 deletions.
33 changes: 33 additions & 0 deletions LICENSE-xxHash
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* xxHash - Fast Hash algorithm
* Copyright (C) 2012-2016, Yann Collet
*
* BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* You can contact the author at :
* - xxHash homepage: http://www.xxhash.com
* - xxHash source repository : https://github.com/Cyan4973/xxHash
*/
22 changes: 13 additions & 9 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
.. mashing-pumpkins documentation master file, created by
sphinx-quickstart on Mon Jan 23 15:17:43 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
mashing-pumpkins : m(in|ax)hash
===============================

Expand All @@ -12,9 +7,6 @@ Flexible-yet-pretty-fast minhash/maxhash-related library for Python > 3.8.
:maxdepth: 2
:caption: Contents:

.. image:: https://travis-ci.org/lgautier/mashing-pumpkins.svg?branch=master
:target: https://travis-ci.org/lgautier/mashing-pumpkins

.. image:: https://img.shields.io/pypi/v/mashing-pumpkins.svg
:target: https://img.shields.io/pypi/v/mashing-pumpkins.svg

Expand All @@ -32,6 +24,11 @@ easy to perform while conserving a reasonable performance profile. At the time
of writing it has a very competitive performance profile both in runtime and
memory usage when compared to alternatives.

Repository
^^^^^^^^^^

https://github.com/lgautier/mashing-pumpkins


Why Minhash sketches ?
^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -80,6 +77,7 @@ The design is allowing us to implement with a relatively short code base:
- "Count sketches"
- Demonstrate quickly the comparative efficiency of alternative hashing strategies for double-stranded genomes (see - https://github.com/marbl/Mash/issues/45#issuecomment-274665746)


Performance
"""""""""""

Expand Down Expand Up @@ -446,7 +444,13 @@ Misc. utilities
.. automodule:: mashingpumpkins.sequence
:members:


LICENSES
--------

xxHash
^^^^^^
.. include:: ../LICENSE-xxHash
:literal:

Indices and tables
==================
Expand Down

0 comments on commit b4ab286

Please sign in to comment.