From f9c43ac375fc4a34d6b9591fc05cd749b556fc44 Mon Sep 17 00:00:00 2001 From: Philip Loche Date: Wed, 26 Jun 2024 09:55:52 +0200 Subject: [PATCH] fix github action badge in README.rst --- .codecov.yml | 4 ++-- README.rst | 11 ++++++----- examples/README.rst | 4 ++-- src/skmatter/datasets/descr/who_dataset.rst | 4 ++-- tox.ini | 2 +- 5 files changed, 13 insertions(+), 12 deletions(-) diff --git a/.codecov.yml b/.codecov.yml index e8dd587ca..98acab721 100644 --- a/.codecov.yml +++ b/.codecov.yml @@ -4,9 +4,9 @@ coverage: status: project: default: - target: 90% + target: 95% patch: default: - target: 90% + target: 95% comment: false diff --git a/README.rst b/README.rst index 555041f6e..90a8f4917 100644 --- a/README.rst +++ b/README.rst @@ -2,8 +2,8 @@ scikit-matter ============= |tests| |codecov| |pypi| |conda| |docs| |doi| -A collection of scikit-learn compatible utilities that implement methods born out of the -materials science and chemistry communities. +A collection of ``scikit-learn`` compatible utilities that implement methods born out of +the materials science and chemistry communities. For details, tutorials, and examples, please have a look at our `documentation`_. @@ -90,10 +90,9 @@ Thanks goes to all people that make scikit-matter possible: .. image:: https://contrib.rocks/image?repo=scikit-learn-contrib/scikit-matter :target: https://github.com/scikit-learn-contrib/scikit-matter/graphs/contributors -.. |tests| image:: https://github.com/scikit-learn-contrib/scikit-matter/workflows/Test/badge.svg +.. |tests| image:: https://github.com/scikit-learn-contrib/scikit-matter/workflows/Tests/badge.svg :alt: Github Actions Tests Job Status - :target: (https://github.com/scikit-learn-contrib/scikit-matter/\ - actions?query=workflow%3ATests) + :target: action_ .. |codecov| image:: https://codecov.io/gh/scikit-learn-contrib/scikit-matter/branch/main/graph/badge.svg?token=UZJPJG34SM :alt: Code coverage @@ -114,3 +113,5 @@ Thanks goes to all people that make scikit-matter possible: .. |doi| image:: https://img.shields.io/badge/DOI-10.12688-blue :alt: ORE Paper :target: https://doi.org/10.12688/openreseurope.15789.2 + +.. _`action`: https://github.com/scikit-learn-contrib/scikit-matter/actions?query=branch%3Amain \ No newline at end of file diff --git a/examples/README.rst b/examples/README.rst index 62f7d24b3..539ac085c 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -1,11 +1,11 @@ Examples ======== -For a thorough tutorial of the methods introduced in `scikit-matter`, we +For a thorough tutorial of the methods introduced in ``scikit-matter``, we suggest you check out the pedagogic notebooks in our companion project `kernel-tutorials `_. -For running the examples locally install `scikit-matter` with the ``examples`` +For running the examples locally install ``scikit-matter`` with the ``examples`` optional dependencies. .. code-block:: bash diff --git a/src/skmatter/datasets/descr/who_dataset.rst b/src/skmatter/datasets/descr/who_dataset.rst index 78ef7ea20..6df0e330b 100644 --- a/src/skmatter/datasets/descr/who_dataset.rst +++ b/src/skmatter/datasets/descr/who_dataset.rst @@ -3,7 +3,7 @@ WHO dataset ########### -`who_dataset.csv` is a compilation of multiple publically-available datasets +``who_dataset.csv`` is a compilation of multiple publically-available datasets through data.worldbank.org. Specifically, the following versioned datasets are used: - NY.GDP.PCAP.CD (v2_4770383) [1]_ @@ -17,7 +17,7 @@ through data.worldbank.org. Specifically, the following versioned datasets are u - SP.DYN.LE00.IN (v2_4770556) [9]_ - SP.POP.TOTL (v2_4770385) [10]_ -where the corresponding file names are `API_{dataset}_DS2_excel_en_{version}.xls`. +where the corresponding file names are ``API_{dataset}_DS2_excel_en_{version}.xls``. This dataset, intended only for demonstration, contains 2020 country-year pairings and the corresponding values above. diff --git a/tox.ini b/tox.ini index a004f8484..2c5c64764 100644 --- a/tox.ini +++ b/tox.ini @@ -65,7 +65,7 @@ commands = black --check --diff {[tox]lint_folders} blackdoc --check --diff {[tox]lint_folders} isort --check-only --diff {[tox]lint_folders} - sphinx-lint --enable line-too-long --max-line-length 88 \ + sphinx-lint --enable all --max-line-length 88 \ -i "{toxinidir}/docs/src/examples" \ {[tox]lint_folders} "{toxinidir}/README.rst"