Skip to content

Commit

Permalink
Update badges for ReadTheDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
breimanntools committed Apr 9, 2024
1 parent 7d88ade commit b523b64
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 19 deletions.
17 changes: 9 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,22 @@ Welcome to the AAanalysis documentation!
:alt: License

.. Group 2: Testing badges
.. |Documentation Status| image:: https://readthedocs.org/projects/aaanalysis/badge/?version=latest
:target: https://aaanalysis.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. |Unit Tests| image:: https://github.com/breimanntools/aaanalysis/actions/workflows/main.yml/badge.svg
:target: https://github.com/breimanntools/aaanalysis/actions/workflows/main.yml
:alt: CI/CD Pipeline

.. |CodeQL| image:: https://github.com/breimanntools/aaanalysis/actions/workflows/codeql_analysis.yml/badge.svg
:target: https://github.com/breimanntools/aaanalysis/actions/workflows/codeql_analysis.yml
:alt: CodeQL

.. |Codecov| image:: https://codecov.io/gh/breimanntools/aaanalysis/branch/master/graph/badge.svg
:target: https://codecov.io/gh/breimanntools/aaanalysis
:alt: Codecov

.. |CodeQL| image:: https://github.com/breimanntools/aaanalysis/actions/workflows/codeql_analysis.yml/badge.svg
:target: https://github.com/breimanntools/aaanalysis/actions/workflows/codeql_analysis.yml
:alt: CodeQL
.. |Documentation Status| image:: https://readthedocs.org/projects/aaanalysis/badge/?version=latest
:target: https://aaanalysis.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status


.. Group 3: Potential badges for future
.. |Conda Version| image:: https://anaconda.org/conda-forge/aaanalysis/badges/version.svg
Expand All @@ -60,7 +61,7 @@ Welcome to the AAanalysis documentation!
* - **Package**
- |PyPI Status| |PyPI Version| |Supported Python Versions| |Downloads| |License|
* - **Testing**
- |Documentation Status| |Unit Tests| |Codecov| |CodeQL|
- |Unit Tests| |CodeQL| |Codecov| |Documentation Status|

**AAanalysis** (Amino Acid analysis) is a Python framework for interpretable sequence-based protein prediction.
Its foundation are the following algorithms:
Expand Down
24 changes: 13 additions & 11 deletions docs/source/index/badges.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,27 +25,29 @@
:alt: License

.. Group 2: Testing badges
.. |Documentation Status| image:: https://readthedocs.org/projects/aaanalysis/badge/?version=latest
:target: https://aaanalysis.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. |CI/CD pipeline| image:: https://github.com/breimanntools/aaanalysis/actions/workflows/main.yml/badge.svg
.. |Unit Tests| image:: https://github.com/breimanntools/aaanalysis/actions/workflows/main.yml/badge.svg
:target: https://github.com/breimanntools/aaanalysis/actions/workflows/main.yml
:alt: CI/CD Pipeline

.. |Test Coverage| image:: https://github.com/breimanntools/aaanalysis/actions/workflows/test_coverage.yml/badge.svg
:target: https://github.com/breimanntools/aaanalysis/actions/workflows/test_coverage.yml
:alt: Test Coverage

.. |Code QL| image:: https://github.com/breimanntools/aaanalysis/actions/workflows/codeql_analysis.yml/badge.svg
.. |CodeQL| image:: https://github.com/breimanntools/aaanalysis/actions/workflows/codeql_analysis.yml/badge.svg
:target: https://github.com/breimanntools/aaanalysis/actions/workflows/codeql_analysis.yml
:alt: CodeQL

.. |Codecov| image:: https://codecov.io/gh/breimanntools/aaanalysis/branch/master/graph/badge.svg
:target: https://codecov.io/gh/breimanntools/aaanalysis
:alt: Codecov

.. |Documentation Status| image:: https://readthedocs.org/projects/aaanalysis/badge/?version=latest
:target: https://aaanalysis.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status


.. Group 3: Potential badges for future
.. |Conda Version| image:: https://anaconda.org/conda-forge/aaanalysis/badges/version.svg
:target: https://anaconda.org/conda-forge/aaanalysis
:alt: Conda - Package Version


..
Missing badges
|Conda Version|
Expand All @@ -57,4 +59,4 @@
* - **Package**
- |PyPI Status| |PyPI Version| |Supported Python Versions| |Downloads| |License|
* - **Testing**
- |Documentation Status| |CI/CD pipeline| |Test Coverage| |Code QL|
- |Unit Tests| |CodeQL| |Codecov| |Documentation Status|

0 comments on commit b523b64

Please sign in to comment.