From b80bd5c335ba45353023d6799b267f9aa48dda79 Mon Sep 17 00:00:00 2001 From: clintval Date: Thu, 19 Sep 2024 18:30:34 -0700 Subject: [PATCH] docs: upgrade the docs to rely on bwa-aln-interactive in bioconda --- README.md | 2 +- docs/index.md | 2 +- ...on.md => installation-and-developers-documentation.md} | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) rename docs/{installation.md => installation-and-developers-documentation.md} (96%) diff --git a/README.md b/README.md index beadb52..1def53b 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/index.md b/docs/index.md index 4b9fde1..b676f5f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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) diff --git a/docs/installation.md b/docs/installation-and-developers-documentation.md similarity index 96% rename from docs/installation.md rename to docs/installation-and-developers-documentation.md index dc92613..741c142 100644 --- a/docs/installation.md +++ b/docs/installation-and-developers-documentation.md @@ -1,4 +1,4 @@ -# Installation +# Installation and Developer's Documentation ## Recommended Installation @@ -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. @@ -49,7 +49,7 @@ 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. @@ -57,7 +57,7 @@ Use `mkdocs` to build and serve the documentation. 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