Skip to content

Commit 53480b1

Browse files
Adding files for readthedocs
1 parent bc1c6f1 commit 53480b1

4 files changed

Lines changed: 57 additions & 0 deletions

File tree

documentation/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# preseq documentation
2+
3+
This is the (new) documentation for preseq that uses
4+
[mkdocs](https://mkdocs.readthedocs.io) to generate readthedocs pages.
5+
The public web verison of this documentation is available at
6+
[preseq.readthedocs.io](https://preseq.readthedocs.io), but for users
7+
who wish to see the documentation on a web browser offline, you can
8+
build the documentation locally as described below.
9+
10+
### Dependencies
11+
12+
To build the documentation locally, install mkdocs
13+
```console
14+
pip install -U mkdocs
15+
```
16+
17+
### Local compilation
18+
19+
Build the HTML documentation by running
20+
```console
21+
mkdocs build
22+
```
23+
which will create a `site` directory where markdown files are
24+
converted to HTML
25+
26+
Create a local host for the HTML documentation by running
27+
```console
28+
mkdocs serve
29+
```
30+
This will create the documentation, usually at http://localhost:8000 .

documentation/docs/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# preseq
2+
3+
Under construction... But the PDF documentation still applies and can
4+
be found [here](https://github.com/smithlabcode/preseq).

documentation/docs/quickstart.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Installation
2+
============
3+
4+
## Installation via conda
5+
6+
If you know how to use conda then preseq is available among the
7+
bioconda recipes. You can install it as follows if you have a conda
8+
environment activated:
9+
10+
```console
11+
$ conda install -c bioconda preseq
12+
```
13+
14+
The instructions for installing conda are
15+
[here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html).

documentation/mkdocs.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
site_name: preseq
2+
strict: true
3+
4+
theme: readthedocs
5+
nav:
6+
- Home: 'index.md'
7+
- 'Installation': 'quickstart.md'
8+
- 'preseq on GitHub' : https://github.com/smithlabcode/preseq

0 commit comments

Comments
 (0)