Skip to content

Commit 47dbd2d

Browse files
committed
adding microbiorust-py docs
1 parent e4cea1f commit 47dbd2d

7 files changed

Lines changed: 488 additions & 12 deletions

File tree

docs/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ A blazing-fast, sustainable bioinformatics toolkit written in [Rust](https://www
1515
## Get Started!!
1616
See Installation for details on how to install Rust for Linux, MacOSX and Windows
1717

18-
##Interested in microbiorust-py?## Check out the microbiorust-py section for quick-start & more!
18+
If you want to call microbiorust from Python, that is microbiorust-py:
19+
##Interested in microbiorust-py? Check out the microbiorust-py section for quick-start & more!
1920

20-
for microbiorust-py install with pip, no need to install Rust - see the microbiorust-py section
21+
for ```microbiorust-py``` install with pip, no need to install Rust - see the microbiorust-py section
2122

2223
Start a new project
2324
```cargo new microBioRust_test```

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ nav:
2525
- Windows Install: windows_install.md
2626
- Usage: usage.md
2727
- Formats & Parsing: formats_and_parsing.md
28+
- Python - microbiorust-py: microbiorust-py.md
2829
features:
2930
- navigation.tabs
3031
markdown_extensions:

site/index.html

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,15 @@
297297
</span>
298298
</a>
299299

300+
</li>
301+
302+
<li class="md-nav__item">
303+
<a href="#interested-in-microbiorust-py-check-out-the-microbiorust-py-section-for-quick-start-more" class="md-nav__link">
304+
<span class="md-ellipsis">
305+
Interested in microbiorust-py?## Check out the microbiorust-py section for quick-start &amp; more!
306+
</span>
307+
</a>
308+
300309
</li>
301310

302311
</ul>
@@ -437,6 +446,15 @@
437446
</span>
438447
</a>
439448

449+
</li>
450+
451+
<li class="md-nav__item">
452+
<a href="#interested-in-microbiorust-py-check-out-the-microbiorust-py-section-for-quick-start-more" class="md-nav__link">
453+
<span class="md-ellipsis">
454+
Interested in microbiorust-py?## Check out the microbiorust-py section for quick-start &amp; more!
455+
</span>
456+
</a>
457+
440458
</li>
441459

442460
</ul>
@@ -456,7 +474,7 @@
456474

457475

458476
<h1 id="welcome-to-microbiorust">Welcome to micro<strong>BioRust</strong></h1>
459-
<p>A blazing-fast, sustainable bioinformatics toolkit written in <a href="https://www.rust-lang.org/">Rust</a> — for microbial genomics rresearch, and optimised for functions used in data exploration. </p>
477+
<p>A blazing-fast, sustainable bioinformatics toolkit written in <a href="https://www.rust-lang.org/">Rust</a> — for microbial genomics research, and optimised for functions used in data exploration. </p>
460478
<hr />
461479
<h2 id="features">Features</h2>
462480
<ul>
@@ -466,8 +484,9 @@ <h2 id="features">Features</h2>
466484
</ul>
467485
<hr />
468486
<h2 id="get-started">Get Started!!</h2>
469-
<p>See Installation for details on how to install Rust for Linux, MacOSX and Windows
470-
Interested in microbiorust-py? Check out the microbiorust-py section for quick-start &amp; more! </p>
487+
<p>See Installation for details on how to install Rust for Linux, MacOSX and Windows</p>
488+
<h2 id="interested-in-microbiorust-py-check-out-the-microbiorust-py-section-for-quick-start-more">Interested in microbiorust-py?## Check out the microbiorust-py section for quick-start &amp; more!</h2>
489+
<p>for microbiorust-py install with pip, no need to install Rust - see the microbiorust-py section</p>
471490
<p>Start a new project
472491
<code>cargo new microBioRust_test</code></p>
473492
<p>Add to your Cargo.toml
@@ -477,7 +496,7 @@ <h2 id="get-started">Get Started!!</h2>
477496
<code>cargo add -p heatmap</code><br />
478497
<code>cargo add -p microbiorust-py</code></p>
479498
<p>or clone the repo<br />
480-
<code>git clone https://github.com/LCrossman/microBioRust.git</code></p>
499+
<code>git clone https://github.com/microBioRust/microBioRust.git</code></p>
481500
<p>Build the project<br />
482501
<code>cargo build</code></p>
483502
<p>Run the tests<br />

0 commit comments

Comments
 (0)