From df86e3acdbbd9bd16e192f21021d0798fe838803 Mon Sep 17 00:00:00 2001 From: Philip Loche Date: Mon, 27 May 2024 23:27:50 +0200 Subject: [PATCH] minor typo and style fixes in README.rst --- README.rst | 29 +++++++++-------------------- tox.ini | 4 ++-- 2 files changed, 11 insertions(+), 22 deletions(-) diff --git a/README.rst b/README.rst index 978faca14..731369b13 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,5 @@ scikit-matter ============= - |tests| |codecov| |pypi| |conda| |docs| |doi| A collection of scikit-learn compatible utilities that implement methods born out of the @@ -14,52 +13,44 @@ For details, tutorials, and examples, please have a look at our `documentation`_ Installation ------------ - You can install *scikit-matter* either via pip using .. code-block:: bash pip install skmatter - or conda .. code-block:: bash conda install -c conda-forge skmatter - You can then ``import skmatter`` and use scikit-matter in your projects! .. marker-ci-tests Tests ----- +We are testing our code for Python 3.8 and 3.12 on `Windows Server 2019`_, `macOS 11`_ +and `Ubuntu LTS 22.04`_. -We are testing our code for Python 3.8 and 3.11 on `Windows Server 2019 -`_, -`macOS 11 -`_ -and `Ubuntu LTS 22.04 -`_. +.. _`Windows Server 2019`: https://github.com/actions/runner-images/blob/main/images/win/Windows2019-Readme.md +.. _`macOS 11`: https://github.com/actions/runner-images/blob/main/images/macos/macos-11-Readme.md +.. _`Ubuntu LTS 22.04`: https://github.com/actions/runner-images/blob/main/images/linux/Ubuntu2204-Readme.md .. marker-issues Having problems or ideas? ------------------------- - Having a problem with scikit-matter? Please let us know by `submitting an issue -`_. +`_. -Submit new features or bug fixes through a `pull request -`_. +Submit new features or bug fixes through a `pull request `_. .. marker-contributing Call for Contributions ---------------------- - We always welcome new contributors. If you want to help us take a look at our `contribution guidelines`_ and afterwards you may start with an open issue marked as `good first issue`_. @@ -84,8 +75,7 @@ Writing code is not the only way to contribute to the project. You can also: Citing scikit-matter -------------------- - -If you use scikit-matter for your work, please cite: +If you use *scikit-matter* for your work, please cite: Goscinski A, Principe VP, Fraux G et al. scikit-matter : A Suite of Generalisable Machine Learning Methods Born out of Chemistry @@ -94,11 +84,10 @@ and Materials Science. Open Res Europe 2023, 3:81. Contributors ------------ - 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 + :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 :alt: Github Actions Tests Job Status diff --git a/tox.ini b/tox.ini index 7f0a6c5bf..a004f8484 100644 --- a/tox.ini +++ b/tox.ini @@ -66,8 +66,8 @@ commands = blackdoc --check --diff {[tox]lint_folders} isort --check-only --diff {[tox]lint_folders} sphinx-lint --enable line-too-long --max-line-length 88 \ - -i "{toxinidir}/docs/src/examples" \ - {[tox]lint_folders} "{toxinidir}/README.rst" + -i "{toxinidir}/docs/src/examples" \ + {[tox]lint_folders} "{toxinidir}/README.rst" [testenv:{format,format-unsafe}] description =