Skip to content

Commit

Permalink
Adding files for readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewdavidsmith committed Sep 5, 2022
1 parent bc1c6f1 commit 53480b1
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 0 deletions.
30 changes: 30 additions & 0 deletions documentation/README.md
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 .
4 changes: 4 additions & 0 deletions documentation/docs/index.md
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).
15 changes: 15 additions & 0 deletions documentation/docs/quickstart.md
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).
8 changes: 8 additions & 0 deletions documentation/mkdocs.yml
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

0 comments on commit 53480b1

Please sign in to comment.