diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index c210f39..0000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,33 +0,0 @@ -# This workflow will automatically deploy the mkdocs documentation -# while installing the necessary Python dependencies. -# See https://parkererickson.github.io/portfolio/blog/MkDocsCD/ - -name: docs - -on: - push: - branches: [main] - workflow_dispatch: - -jobs: - build: - name: Build and Deploy Documentation - runs-on: ubuntu-latest - steps: - - name: Checkout Master - uses: actions/checkout@v2 - - - name: Set up Python 3 - uses: actions/setup-python@v2 - with: - python-version: "3.10.8" - - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install . - pip install mkdocstrings mkdocstrings.python - - name: Deploy - run: | - git pull - mkdocs gh-deploy diff --git a/README.md b/README.md index 866f989..4bd025d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # MicroView + [![license](https://img.shields.io/badge/license-BSD%203--Clause-green)](https://github.com/dalmolingroup/microview/blob/master/LICENSE) [![pytest status](https://github.com/dalmolingroup/microview/workflows/test-and-lint/badge.svg)](https://github.com/dalmolingroup/microview/actions) -[![documentation status](https://github.com/dalmolingroup/microview/workflows/docs/badge.svg)](https://dalmolingroup.github.io/MicroView/) +[![Documentation Status](https://readthedocs.org/projects/microview-bio/badge/?version=latest)](https://microview-bio.readthedocs.io/en/latest/?badge=latest) + MicroView, a reporting tool for taxonomic classification @@ -12,7 +14,7 @@ MicroView agreggates results from taxonomic classification tools, such as Kaiju and Kraken, building an interactive HTML report with insightful visualizations. -Checkout the [full documentation](https://dalmolingroup.github.io/MicroView/). +Checkout the [full documentation](https://microview-bio.readthedocs.io/en/latest/?badge=latest). ## Quickstart