-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
remove last .rst file from docs (#1185)
- Loading branch information
Showing
4 changed files
with
42 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# `sourmash` Python API | ||
|
||
The primary programmatic way of interacting with `sourmash` is via | ||
its Python API. Please also see [examples of using the API](api-example.md). | ||
|
||
```{contents} | ||
:depth: 2 | ||
``` | ||
|
||
## `MinHash`: basic MinHash sketch functionality | ||
|
||
```{eval-rst} | ||
.. autoclass:: sourmash.MinHash | ||
:members: | ||
.. automethod:: __init__ | ||
``` | ||
|
||
## `SourmashSignature`: save and load MinHash sketches in JSON | ||
|
||
```{eval-rst} | ||
.. automodule:: sourmash.signature | ||
:members: | ||
``` | ||
|
||
## `SBT`: save and load Sequence Bloom Trees in JSON | ||
|
||
```{eval-rst} | ||
.. automodule:: sourmash.sbt | ||
:members: GraphFactory, Node, NodePos, SBT, Leaf | ||
:undoc-members: | ||
``` | ||
|
||
# `sourmash.fig`: make plots and figures | ||
|
||
```{eval-rst} | ||
.. automodule:: sourmash.fig | ||
:members: | ||
``` |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters