Skip to content

Commit

Permalink
docs: link to docs site from docs workflow badge
Browse files Browse the repository at this point in the history
  • Loading branch information
kelly-sovacool committed Dec 30, 2024
1 parent 520921e commit 4c729b1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Utilities for CCBR Bioinformatics Software

[![build](https://github.com/CCBR/Tools/actions/workflows/build-python.yml/badge.svg)](https://github.com/CCBR/Tools/actions/workflows/build-python.yml)
[![docs](https://github.com/CCBR/Tools/actions/workflows/docs-quartodoc.yml/badge.svg)](https://github.com/CCBR/Tools/actions/workflows/docs-quartodoc.yml)
[![docs](https://github.com/CCBR/Tools/actions/workflows/docs-quartodoc.yml/badge.svg)](https://ccbr.github.io/Tools)
[![codecov](https://codecov.io/gh/CCBR/Tools/graph/badge.svg?token=O73NOR65B3)](https://codecov.io/gh/CCBR/Tools)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13377166.svg)](https://doi.org/10.5281/zenodo.13377166)

Expand All @@ -17,27 +17,27 @@ View the website for more detailed documentation:
On [biowulf](https://hpc.nih.gov/) you can access the latest release of
`ccbr_tools` by loading the ccbrpipeliner module:

``` sh
```sh
module load ccbrpipeliner
```

Outside of biowulf, you can install the package with pip:

``` sh
```sh
pip install git+https://github.com/CCBR/Tools
```

Or specify any tagged version or branch:

``` sh
```sh
pip install git+https://github.com/CCBR/Tools@v0.1.0
```

## Basic usage

### CLI

``` sh
```sh
ccbr_tools --help
```

Expand Down Expand Up @@ -68,7 +68,7 @@ ccbr_tools --help

### Python

``` python
```python
import ccbr_tools.pkg_util
print(ccbr_tools.pkg_util.get_version())
```
Expand Down Expand Up @@ -148,7 +148,7 @@ Please cite this software if you use it in a publication:
### Bibtex entry

``` bibtex
```bibtex
@misc{YourReferenceHere,
author = {Sovacool, Kelly and Koparde, Vishal and Kuhn, Skyler and Tandon, Mayank and Huse, Susan},
doi = {10.5281/zenodo.13377166},
Expand Down
2 changes: 1 addition & 1 deletion docs/badges.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
Utilities for CCBR Bioinformatics Software

[![build](https://github.com/CCBR/Tools/actions/workflows/build-python.yml/badge.svg)](https://github.com/CCBR/Tools/actions/workflows/build-python.yml)
[![docs](https://github.com/CCBR/Tools/actions/workflows/docs-quartodoc.yml/badge.svg)](https://github.com/CCBR/Tools/actions/workflows/docs-quartodoc.yml)
[![docs](https://github.com/CCBR/Tools/actions/workflows/docs-quartodoc.yml/badge.svg)](https://ccbr.github.io/Tools)
[![codecov](https://codecov.io/gh/CCBR/Tools/graph/badge.svg?token=O73NOR65B3)](https://codecov.io/gh/CCBR/Tools)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13377166.svg)](https://doi.org/10.5281/zenodo.13377166)

0 comments on commit 4c729b1

Please sign in to comment.