diff --git a/.github/workflows/documentation-build.yml b/.github/workflows/documentation-build.yml index 428e6c60034..8908c8cc2bd 100644 --- a/.github/workflows/documentation-build.yml +++ b/.github/workflows/documentation-build.yml @@ -1,7 +1,7 @@ # For more information on how to use this template please refer to: # http://tardis-sn.github.io/tardis/development/continuous_integration.html -name: documentation-build +name: docs on: push: @@ -14,7 +14,7 @@ on: workflow_dispatch: # Manual trigger jobs: - documentation_build: + build: runs-on: ubuntu-latest steps: diff --git a/README.rst b/README.rst index aed39c4b06b..4d713dd1c1e 100644 --- a/README.rst +++ b/README.rst @@ -1,28 +1,19 @@ -****** +====== TARDIS -****** +====== -.. image:: https://img.shields.io/badge/read-documentation-blue - :target: https://tardis-sn.github.io/tardis +TARDIS is a tool that creates synthetic observations (*spectra*) for exploding +stars (*supernovae*). -.. image:: https://dev.azure.com/tardis-sn/TARDIS/_apis/build/status/tardis-sn.tardis?branchName=master - :target: https://dev.azure.com/tardis-sn/TARDIS/_build/latest?definitionId=1&branchName=master +.. image:: https://img.shields.io/badge/Donate-to%20TARDIS-brightgreen.svg + :target: https://numfocus.salsalabs.org/donate-to-tardis/index.html .. image:: https://codecov.io/gh/tardis-sn/tardis/branch/master/graph/badge.svg - :target: https://codecov.io/gh/tardis-sn/tardis - -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3893940.svg - :target: https://doi.org/10.5281/zenodo.3893940 + :target: https://codecov.io/gh/tardis-sn/tardis -.. image:: https://badges.gitter.im/Join%20Chat.svg - :target: https://gitter.im/tardis-sn/tardis +.. image:: https://img.shields.io/badge/DOI-10.5281%2Fzenodo.592480-blue + :target: https://doi.org/10.5281/zenodo.592480 -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - -.. image:: https://img.shields.io/badge/Donate-to%20TARDIS-brightgreen.svg - :target: https://numfocus.salsalabs.org/donate-to-tardis/index.html - .. image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A :target: http://numfocus.org :alt: Powered by NumFOCUS @@ -30,8 +21,21 @@ TARDIS .. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat :target: http://www.astropy.org -TARDIS is a tool that creates synthetic observations (spectra) for exploding -stars (supernovae). +.. image:: https://badges.gitter.im/Join%20Chat.svg + :target: https://gitter.im/tardis-sn/tardis + +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + +.. image:: https://github.com/tardis-sn/tardis/actions/workflows/documentation-build.yml/badge.svg + :target: https://tardis-sn.github.io/tardis/index.html + +.. image:: https://dev.azure.com/tardis-sn/TARDIS/_apis/build/status/TARDIS%20tests?repoName=tardis-sn%2Ftardis&branchName=refs%2Fpull%2F1573%2Fmerge + :target: https://dev.azure.com/tardis-sn/TARDIS/_build/latest?definitionId=3&repoName=tardis-sn%2Ftardis&branchName=refs%2Fpull%2F1573%2Fmerge + + + + ****************************** Credits & Publication Policies @@ -40,12 +44,13 @@ Credits & Publication Policies We provide TARDIS as a free, open-source tool. If you are using it, please adhere to a few policies and acknowledge the TARDIS Team. + Publication Policies ==================== If you use this code for any publications or presentations please acknowledge it. Please cite `Kerzendorf & Sim 2014 -`_ in the text +`_ in the text. Please add this paragraph to the Acknowledgement: @@ -60,7 +65,6 @@ Please add this paragraph to the Acknowledgement: extensive use of Astropy and PyNE. - If you use any of the full relativity treatments or use TARDIS for modelling Type II supernovae you also add this citation to acknowledgement `Spectral modeling of type II supernovae. I. Dilution factors @@ -70,7 +74,7 @@ modelling Type II supernovae you also add this citation to acknowledgement \citep{2019A&A...621A..29V} -The following bibtex entries are needed for the references. +The following BibTeX entries are needed for the references: .. code-block:: none