Skip to content

Commit

Permalink
Merge pull request #224 from crim-ca/readme-fix
Browse files Browse the repository at this point in the history
patches to readme badges
  • Loading branch information
fmigneault authored Mar 2, 2021
2 parents ec7bfcf + 1ec06e9 commit fc15b43
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ For more details, see `Configuration`_ section.
* - dependencies
- | |py_ver| |requires| |pyup|
* - build status
- | |readthedocs| |coverage| |codacy|
- | |readthedocs| |docker_build_mode| |docker_build_status|
* - tests status
- | |github_latest| |github_tagged| |coverage| |codacy|
* - releases
Expand Down Expand Up @@ -66,8 +66,18 @@ For more details, see `Configuration`_ section.
:target: https://github.com/crim-ca/weaver/actions?query=workflow%3ATests+branch%3A2.1.0

.. |readthedocs| image:: https://img.shields.io/readthedocs/pavics-weaver
:alt: Readthedocs Build Status (master branch)
:target: `readthedocs`_
:alt: ReadTheDocs Build Status (master branch)
:target: `ReadTheDocs`_

.. |docker_build_mode| image:: https://img.shields.io/docker/automated/pavics/weaver.svg?label=build
:alt: Docker Build Mode (latest version)
:target: https://hub.docker.com/r/pavics/weaver/tags

.. below shield will either indicate the targeted version or 'tag not found'
.. since docker tags are pushed following manual builds by CI, they are not automatic and no build artifact exists
.. |docker_build_status| image:: https://img.shields.io/docker/v/pavics/weaver/2.0.0?label=tag%20status
:alt: Docker Build Status (latest version)
:target: https://hub.docker.com/r/pavics/weaver/tags

.. |coverage| image:: https://img.shields.io/codecov/c/gh/crim-ca/weaver.svg?label=coverage
:alt: Code Coverage
Expand Down Expand Up @@ -160,12 +170,12 @@ Documentation

The REST API documentation is auto-generated and served under any running `Weaver` application on route
``{WEAVER_URL}/api/``. This documentation will correspond to the version of the executed `Weaver` application.
For the latest documentation, you can refer to the `OpenAPI Specification`_ served directly on `readthedocs`_.
For the latest documentation, you can refer to the `OpenAPI Specification`_ served directly on `ReadTheDocs`_.

More ample details about installation, configuration and usage are also provided on `readthedocs`_.
More ample details about installation, configuration and usage are also provided on `ReadTheDocs`_.
These are generated from corresponding information provided in `docs`_ source directory.

.. _readthedocs: https://pavics-weaver.readthedocs.io
.. _ReadTheDocs: https://pavics-weaver.readthedocs.io
.. _`OpenAPI Specification`: https://pavics-weaver.readthedocs.io/en/latest/api.html
.. _docs: ./docs

Expand Down

0 comments on commit fc15b43

Please sign in to comment.