Skip to content

Commit

Permalink
Change badges layout in README & dev docs to table
Browse files Browse the repository at this point in the history
  • Loading branch information
@douglatornell
douglatornell committed Dec 19, 2023
1 parent ce16021 commit 7d148d9
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 70 deletions.
80 changes: 45 additions & 35 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,51 @@
UBC EOAS MOAD Group Tools Package
*********************************

:License: Apache License, Version 2.0

.. image:: https://img.shields.io/badge/license-Apache%202-cb2533.svg
:target: https://www.apache.org/licenses/LICENSE-2.0
:alt: Licensed under the Apache License, Version 2.0
.. image:: https://img.shields.io/badge/Python-3.11%20%7C%203.12-blue?logo=python&label=Python&logoColor=gold
:target: https://docs.python.org/3.12/
:alt: Python Version
.. image:: https://img.shields.io/badge/version%20control-git-blue.svg?logo=github
:target: https://github.com/UBC-MOAD/moad_tools
:alt: Git on GitHub
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://black.readthedocs.io/en/stable/
:alt: The uncompromising Python code formatter
.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg
:target: https://github.com/pypa/hatch
:alt: Hatch project
.. image:: https://readthedocs.org/projects/ubc-moad-tools/badge/?version=latest
:target: https://ubc-moad-tools.readthedocs.io/en/latest/
:alt: Documentation Status
.. image:: https://github.com/UBC-MOAD/moad_tools/workflows/sphinx-linkcheck/badge.svg
:target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow%3Asphinx-linkcheck
:alt: Sphinx linkcheck
.. image:: https://github.com/UBC-MOAD/moad_tools/workflows/pytest-with-coverage/badge.svg
:target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow%3Apytest-with-coverage
:alt: Pytest with Coverage Status
.. image:: https://codecov.io/gh/UBC-MOAD/moad_tools/branch/main/graph/badge.svg
:target: https://app.codecov.io/gh/UBC-MOAD/moad_tools
:alt: Codecov Testing Coverage Report
.. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/codeql-analysis.yaml/badge.svg
:target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:codeql-analysis
:alt: CodeQL analysis
.. image:: https://img.shields.io/github/issues/UBC-MOAD/moad_tools?logo=github
:target: https://github.com/UBC-MOAD/moad_tools/issues
:alt: Issue Tracker
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| **Continuous Integration** | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/pytest-with-coverage.yaml/badge.svg |
| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:pytest-with-coverage |
| | :alt: Pytest with Coverage Status |
| | .. image:: https://codecov.io/gh/UBC-MOAD/moad_tools/branch/main/graph/badge.svg |
| | :target: https://app.codecov.io/gh/UBC-MOAD/moad_tools |
| | :alt: Codecov Testing Coverage Report |
| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/codeql-analysis.yaml/badge.svg |
| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:CodeQL |
| | :alt: CodeQL analysis |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| **Documentation** | .. image:: https://readthedocs.org/projects/ubc-moad-tools/badge/?version=latest |
| | :target: https://ubc-moad-tools.readthedocs.io/en/latest/ |
| | :alt: Documentation Status |
| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/sphinx-linkcheck.yaml/badge.svg |
| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:sphinx-linkcheck |
| | :alt: Sphinx linkcheck |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| **Package** | .. image:: https://img.shields.io/github/v/release/UBC-MOAD/moad_tools?logo=github |
| | :target: https://github.com/UBC-MOAD/moad_tools/releases |
| | :alt: Releases |
| | .. image:: https://img.shields.io/badge/Python-3.11%20%7C%203.12-blue?logo=python&label=Python&logoColor=gold |
| | :target: https://docs.python.org/3.12/ |
| | :alt: Python Version |
| | .. image:: https://img.shields.io/github/issues/UBC-MOAD/moad_tools?logo=github |
| | :target: https://github.com/UBC-MOAD/moad_tools/issues |
| | :alt: Issue Tracker |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| **Meta** | .. image:: https://img.shields.io/badge/license-Apache%202-cb2533.svg |
| | :target: https://www.apache.org/licenses/LICENSE-2.0 |
| | :alt: Licensed under the Apache License, Version 2.0 |
| | .. image:: https://img.shields.io/badge/version%20control-git-blue.svg?logo=github |
| | :target: https://github.com/UBC-MOAD/moad_tools |
| | :alt: Git on GitHub |
| | .. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white |
| | :target: https://pre-commit.com |
| | :alt: pre-commit |
+ +-----------------------------------------------------------------------------------------------------------------+
| | .. image:: https://img.shields.io/badge/code%20style-black-000000.svg |
| | :target: https://black.readthedocs.io/en/stable/ |
| | :alt: The uncompromising Python code formatter |
| | .. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg |
| | :target: https://github.com/pypa/hatch |
| | :alt: Hatch project |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+

The UBC EOAS MOAD Group Tools package (``moad_tools``) is a collection of
Python modules that facilitate code reuse for the UBC EOAS MOAD Group.
Expand Down
82 changes: 47 additions & 35 deletions docs/pkg_development.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,39 +22,51 @@
:py:obj:`moad_tools` Package Development
****************************************

.. image:: https://img.shields.io/badge/license-Apache%202-cb2533.svg
:target: https://www.apache.org/licenses/LICENSE-2.0
:alt: Licensed under the Apache License, Version 2.0
.. image:: https://img.shields.io/badge/Python-3.11%20%7C%203.12-blue?logo=python&label=Python&logoColor=gold
:target: https://docs.python.org/3.12/
:alt: Python Version
.. image:: https://img.shields.io/badge/version%20control-git-blue.svg?logo=github
:target: https://github.com/UBC-MOAD/moad_tools
:alt: Git on GitHub
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://black.readthedocs.io/en/stable/
:alt: The uncompromising Python code formatter
.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg
:target: https://github.com/pypa/hatch
:alt: Hatch project
.. image:: https://readthedocs.org/projects/ubc-moad-tools/badge/?version=latest
:target: https://ubc-moad-tools.readthedocs.io/en/latest/
:alt: Documentation Status
.. image:: https://github.com/UBC-MOAD/moad_tools/workflows/sphinx-linkcheck/badge.svg
:target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow%3Asphinx-linkcheck
:alt: Sphinx linkcheck
.. image:: https://github.com/UBC-MOAD/moad_tools/workflows/pytest-with-coverage/badge.svg
:target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow%3Apytest-with-coverage
:alt: Pytest with Coverage Status
.. image:: https://codecov.io/gh/UBC-MOAD/moad_tools/branch/main/graph/badge.svg
:target: https://app.codecov.io/gh/UBC-MOAD/moad_tools
:alt: Codecov Testing Coverage Report
.. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/codeql-analysis.yaml/badge.svg
:target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:codeql-analysis
:alt: CodeQL analysis
.. image:: https://img.shields.io/github/issues/UBC-MOAD/moad_tools?logo=github
:target: https://github.com/UBC-MOAD/moad_tools/issues
:alt: Issue Tracker
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| **Continuous Integration** | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/pytest-with-coverage.yaml/badge.svg |
| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:pytest-with-coverage |
| | :alt: Pytest with Coverage Status |
| | .. image:: https://codecov.io/gh/UBC-MOAD/moad_tools/branch/main/graph/badge.svg |
| | :target: https://app.codecov.io/gh/UBC-MOAD/moad_tools |
| | :alt: Codecov Testing Coverage Report |
| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/codeql-analysis.yaml/badge.svg |
| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:CodeQL |
| | :alt: CodeQL analysis |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| **Documentation** | .. image:: https://readthedocs.org/projects/ubc-moad-tools/badge/?version=latest |
| | :target: https://ubc-moad-tools.readthedocs.io/en/latest/ |
| | :alt: Documentation Status |
| | .. image:: https://github.com/UBC-MOAD/moad_tools/actions/workflows/sphinx-linkcheck.yaml/badge.svg |
| | :target: https://github.com/UBC-MOAD/moad_tools/actions?query=workflow:sphinx-linkcheck |
| | :alt: Sphinx linkcheck |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| **Package** | .. image:: https://img.shields.io/github/v/release/UBC-MOAD/moad_tools?logo=github |
| | :target: https://github.com/UBC-MOAD/moad_tools/releases |
| | :alt: Releases |
| | .. image:: https://img.shields.io/badge/Python-3.11%20%7C%203.12-blue?logo=python&label=Python&logoColor=gold |
| | :target: https://docs.python.org/3.12/ |
| | :alt: Python Version |
| | .. image:: https://img.shields.io/github/issues/UBC-MOAD/moad_tools?logo=github |
| | :target: https://github.com/UBC-MOAD/moad_tools/issues |
| | :alt: Issue Tracker |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| **Meta** | .. image:: https://img.shields.io/badge/license-Apache%202-cb2533.svg |
| | :target: https://www.apache.org/licenses/LICENSE-2.0 |
| | :alt: Licensed under the Apache License, Version 2.0 |
| | .. image:: https://img.shields.io/badge/version%20control-git-blue.svg?logo=github |
| | :target: https://github.com/UBC-MOAD/moad_tools |
| | :alt: Git on GitHub |
| | .. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white |
| | :target: https://pre-commit.com |
| | :alt: pre-commit |
+ +-----------------------------------------------------------------------------------------------------------------+
| | .. image:: https://img.shields.io/badge/code%20style-black-000000.svg |
| | :target: https://black.readthedocs.io/en/stable/ |
| | :alt: The uncompromising Python code formatter |
| | .. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg |
| | :target: https://github.com/pypa/hatch |
| | :alt: Hatch project |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+

The UBC EOAS MOAD Group Tools package (:py:obj:`moad_tools`) is a collection of
Python modules that facilitate code reuse for the UBC EOAS MOAD Group.
Expand Down Expand Up @@ -510,8 +522,8 @@ Please see the LICENSE file for details of the license.
Release Process
===============

.. image:: https://img.shields.io/github/v/release/UBC-MOAD/Reshapr?logo=github
:target: https://github.com/UBC-MOAD/Reshapr/releases
.. image:: https://img.shields.io/github/v/release/UBC-MOAD/moad_tools?logo=github
:target: https://github.com/UBC-MOAD/moad_tools/releases
:alt: Releases
.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg
:target: https://github.com/pypa/hatch
Expand Down

0 comments on commit 7d148d9

Please sign in to comment.