Skip to content

Commit

Permalink
docs: upgrade the docs to rely on bwa-aln-interactive in bioconda
Browse files Browse the repository at this point in the history
  • Loading branch information
clintval committed Sep 20, 2024
1 parent 54e033b commit b80bd5c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ mamba install -c bioconda prymer

See the [developer's instructions][developers-instructions-link] for more information.

[developers-instructions-link]: https://prymer.readthedocs.io/en/latest/installation.html#installation-for-development
[developers-instructions-link]: https://prymer.readthedocs.io/en/latest/installation-and-developers-documentation.html#installation-for-development
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Python Primer Design Library

## Documentation Contents

* [Installation](installation.md)
* [Installation](installation-and-developers-documentation.md)
* [Overview](overview.md)
* [API](reference/prymer/index.md)

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Installation
# Installation and Developer's Documentation

## Recommended Installation

Expand Down Expand Up @@ -31,7 +31,7 @@ mamba install -c bioconda prymer
poetry install
```

## Checking the Build
# Checking the Build

Make sure that [instructions for development work](#getting-setup-for-development-work) have been followed.

Expand All @@ -49,15 +49,15 @@ However, `pytest` will neither run the ruff formatter nor apply `ruff`'s automat
poetry run ruff format && poetry run ruff check --fix
```

## Building the Documentation
# Building the Documentation

Use `mkdocs` to build and serve the documentation.

```console
poetry run mkdocs build && poetry run mkdocs serve
```

## Creating a Release on PyPi
# Creating a Release on PyPi

1. Clone the repository recursively and ensure you are on the `main` (un-dirty) branch
2. Checkout a new branch to prepare the library for release
Expand Down

0 comments on commit b80bd5c

Please sign in to comment.