Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vlad0x00 committed Apr 10, 2022
1 parent 929d3f3 commit def3dd3
Show file tree
Hide file tree
Showing 6 changed files with 305 additions and 292 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For users
* `btllib` uses `C++11` features, so that standard should be enabled at a minimum.
- Python wrappers
* The wrappers correspond one-to-one with C++ code so any functions and classes can be used under the same name. The only exception are nested classes which are prefixed with outer class name (e.g. `btllib::SeqReader::Flag` in C++ versus `btllib.SeqReaderFlag` in Python).
* Use `PYTHONPATH` environment variable or `sys.path.append()` in your Python code to include `/path/to/btllib/install/lib/btllib` directory
* Use `PYTHONPATH` environment variable or `sys.path.append()` in your Python code to include `/path/to/btllib/install/lib/btllib/python` directory
* Include the library with `import btllib`
- Executables
* btllib generated executables can be found in `/path/to/btllib/install/bin` directory. Append that path to the `PATH` environment variable to make it available to your shell.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ <h2><a class="anchor" id="autotoc_md4"></a>
</li>
<li>Python wrappers<ul>
<li>The wrappers correspond one-to-one with C++ code so any functions and classes can be used under the same name. The only exception are nested classes which are prefixed with outer class name (e.g. <code><a class="el" href="structbtllib_1_1SeqReader_1_1Flag.html">btllib::SeqReader::Flag</a></code> in C++ versus <code>btllib.SeqReaderFlag</code> in Python).</li>
<li>Use <code>PYTHONPATH</code> environment variable or <code>sys.path.append()</code> in your Python code to include <code>/path/to/btllib/install/python</code> directory</li>
<li>Use <code>PYTHONPATH</code> environment variable or <code>sys.path.append()</code> in your Python code to include <code>/path/to/btllib/install/lib/btllib/python</code> directory</li>
<li>Include the library with <code>import btllib</code></li>
</ul>
</li>
Expand Down
4 changes: 4 additions & 0 deletions docs/namespacebtllib.html
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,10 @@
<tr class="memitem:ac93026bb711d0a4108416cd63ce0b2b2"><td class="memItemLeft" align="right" valign="top"><a id="ac93026bb711d0a4108416cd63ce0b2b2" name="ac93026bb711d0a4108416cd63ce0b2b2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ntmsm64l</b> (nthash.seq+nthash.pos - 1, blocks, monomers, nthash.k, blocks.size(), hash_num_per_seed, fh_no_monomers_tmp.get(), rh_no_monomers_tmp.get(), forward_hash_tmp.get(), reverse_hash_tmp.get(), nthash.hashes_array.get())</td></tr>
<tr class="separator:ac93026bb711d0a4108416cd63ce0b2b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea4acde96831ed23d6c72ed74b460f1a"><td class="memTemplParams" colspan="2"><a id="aea4acde96831ed23d6c72ed74b460f1a" name="aea4acde96831ed23d6c72ed74b460f1a"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:aea4acde96831ed23d6c72ed74b460f1a"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><b>canonical</b> (const T fwd, const T rev)</td></tr>
<tr class="separator:aea4acde96831ed23d6c72ed74b460f1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d172327f4a061736fa3788a476da88f"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacebtllib.html#a3d172327f4a061736fa3788a476da88f">srol</a> (const uint64_t x)</td></tr>
<tr class="separator:a3d172327f4a061736fa3788a476da88f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8adee205e2a9bc7509250a46f01a2c40"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacebtllib.html#a8adee205e2a9bc7509250a46f01a2c40">srol</a> (const uint64_t x, const unsigned d)</td></tr>
Expand Down
Loading

0 comments on commit def3dd3

Please sign in to comment.