From c8131a9c43f0233187a7a93c4116dc1803b221e3 Mon Sep 17 00:00:00 2001 From: Philip Loche Date: Wed, 26 Jun 2024 10:10:17 +0200 Subject: [PATCH] reuse links in README --- README.rst | 12 ++++++++---- docs/src/index.rst | 10 +++++++--- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 90a8f4917..aae896c4c 100644 --- a/README.rst +++ b/README.rst @@ -72,7 +72,7 @@ Writing code is not the only way to contribute to the project. You can also: .. _`examples and tutorials`: https://scikit-matter.readthedocs.io/en/latest/contributing.html#contributing-new-examples .. _`new datasets`: https://scikit-matter.readthedocs.io/en/latest/contributing.html#contributing-datasets -.. marker-contributors +.. marker-citing Citing scikit-matter -------------------- @@ -81,7 +81,11 @@ 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 and Materials Science. Open Res Europe 2023, 3:81. -`10.12688/openreseurope.15789.2 `_ +`10.12688/openreseurope.15789.2`_ + +.. _`10.12688/openreseurope.15789.2`: https://doi.org/10.12688/openreseurope.15789.2 + +.. marker-contributors Contributors ------------ @@ -100,7 +104,7 @@ Thanks goes to all people that make scikit-matter possible: .. |docs| image:: https://img.shields.io/badge/documentation-latest-sucess :alt: Python - :target: https://scikit-matter.readthedocs.io + :target: documentation_ .. |pypi| image:: https://img.shields.io/pypi/v/skmatter.svg :alt: Latest PYPI version @@ -112,6 +116,6 @@ 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 + :target: `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/docs/src/index.rst b/docs/src/index.rst index ad9b5274c..2095eab22 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -74,6 +74,13 @@ :start-after: marker-issues :end-before: marker-contributing +.. include:: ../../README.rst + :start-after: marker-citing + :end-before: marker-contributors + +If you would like to contribute to scikit-matter, check out our :ref:`contributing` +page! + .. toctree:: :hidden: @@ -84,6 +91,3 @@ contributing changelog bibliography - -If you would like to contribute to scikit-matter, check out our :ref:`contributing` -page!