-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bc1c6f1
commit 53480b1
Showing
4 changed files
with
57 additions
and
0 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,30 @@ | ||
# preseq documentation | ||
|
||
This is the (new) documentation for preseq that uses | ||
[mkdocs](https://mkdocs.readthedocs.io) to generate readthedocs pages. | ||
The public web verison of this documentation is available at | ||
[preseq.readthedocs.io](https://preseq.readthedocs.io), but for users | ||
who wish to see the documentation on a web browser offline, you can | ||
build the documentation locally as described below. | ||
|
||
### Dependencies | ||
|
||
To build the documentation locally, install mkdocs | ||
```console | ||
pip install -U mkdocs | ||
``` | ||
|
||
### Local compilation | ||
|
||
Build the HTML documentation by running | ||
```console | ||
mkdocs build | ||
``` | ||
which will create a `site` directory where markdown files are | ||
converted to HTML | ||
|
||
Create a local host for the HTML documentation by running | ||
```console | ||
mkdocs serve | ||
``` | ||
This will create the documentation, usually at http://localhost:8000 . |
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,4 @@ | ||
# preseq | ||
|
||
Under construction... But the PDF documentation still applies and can | ||
be found [here](https://github.com/smithlabcode/preseq). |
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,15 @@ | ||
Installation | ||
============ | ||
|
||
## Installation via conda | ||
|
||
If you know how to use conda then preseq is available among the | ||
bioconda recipes. You can install it as follows if you have a conda | ||
environment activated: | ||
|
||
```console | ||
$ conda install -c bioconda preseq | ||
``` | ||
|
||
The instructions for installing conda are | ||
[here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html). |
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,8 @@ | ||
site_name: preseq | ||
strict: true | ||
|
||
theme: readthedocs | ||
nav: | ||
- Home: 'index.md' | ||
- 'Installation': 'quickstart.md' | ||
- 'preseq on GitHub' : https://github.com/smithlabcode/preseq |