Skip to content

Commit

Permalink
reuse links in README
Browse files Browse the repository at this point in the history
  • Loading branch information
PicoCentauri committed Jun 26, 2024
1 parent f9c43ac commit c8131a9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
12 changes: 8 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------
Expand All @@ -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 <https://doi.org/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
------------
Expand All @@ -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
Expand All @@ -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
10 changes: 7 additions & 3 deletions docs/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -84,6 +91,3 @@
contributing
changelog
bibliography

If you would like to contribute to scikit-matter, check out our :ref:`contributing`
page!

0 comments on commit c8131a9

Please sign in to comment.