From 816c44e929f74992d2e1440c02ad0b3e0b4fc8eb Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Fri, 10 Sep 2021 14:03:08 +0100
Subject: [PATCH 01/20] Update citation file with JOSS paper reference

---
 CITATION.rst | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/CITATION.rst b/CITATION.rst
index 04e06d0a2..3d51cb749 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -1,6 +1,11 @@
 If you use SkyPy for work or research presented in a publication (whether
 directly, or as a dependency to another package) we recommend and encourage
-the following acknowledgment:
+the citation to the following paper in the main text (wherever appropriate):
+
+  Amara et al. (2021)_ Amara et al., (2021). SkyPy: A package for modelling the Universe.
+  Journal of Open Source Software, 6(65), 3056.
+
+and the following acknowledgment:
 
   This research made use of SkyPy, a Python package for forward modeling
   astronomical surveys (SkyPy Collaboration, 2020).
@@ -10,4 +15,5 @@ specific version that you used. We also encourage you to cite the software DOI
 in the main text wherever appropriate. DOIs and BibTeX keys for each release
 can be found on Zenodo_.
 
+.. _Amara et al. (2021): https://doi.org/10.21105/joss.03056
 .. _Zenodo: https://zenodo.org/record/3755531

From cb781e0133c2d70cf4937bafecda3317b9c5a44f Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Fri, 10 Sep 2021 14:07:06 +0100
Subject: [PATCH 02/20] Create file to link the citation rst file to docs

---
 docs/developer/citation.rst | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 docs/developer/citation.rst

diff --git a/docs/developer/citation.rst b/docs/developer/citation.rst
new file mode 100644
index 000000000..ff43a0525
--- /dev/null
+++ b/docs/developer/citation.rst
@@ -0,0 +1 @@
+.. include:: ../../CITATION.rst

From a2e7eabe6dfcd4c9ca8d670912f4999a4bea6d02 Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Fri, 10 Sep 2021 14:19:15 +0100
Subject: [PATCH 03/20] Add link to the citation file in the docs

---
 docs/index.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index e3efcf7e6..89db66ab5 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,8 +11,10 @@ intention the simulations can then be compared to data as part of an inference
 pipeline.
 
 .. Important:: If you use SkyPy for work presented in a publication or talk
-   please help the project via proper `citation or acknowledgement
-   <https://github.com/skypyproject/skypy/blob/main/CITATION.rst>`_.
+   please help the project via proper :doc:`citation or acknowledgement
+   <developer/citation>`.
+
+
 
 .. _getting-started:
 

From f2fa12b34419369c2ec36d1627d71b197226d64d Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Fri, 10 Sep 2021 14:20:58 +0100
Subject: [PATCH 04/20] Add titel to the citation guidelines

---
 CITATION.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/CITATION.rst b/CITATION.rst
index 3d51cb749..7941785ab 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -1,3 +1,6 @@
+Citation Guidelines
+===================
+
 If you use SkyPy for work or research presented in a publication (whether
 directly, or as a dependency to another package) we recommend and encourage
 the citation to the following paper in the main text (wherever appropriate):

From d4078de4b8cfa742eee03d03711ac262ebf1711a Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Fri, 10 Sep 2021 15:06:08 +0100
Subject: [PATCH 05/20] Create BibTeX download button'

---
 CITATION.rst | 10 ++++++++++
 main.bib     | 22 ++++++++++++++++++++++
 2 files changed, 32 insertions(+)
 create mode 100644 main.bib

diff --git a/CITATION.rst b/CITATION.rst
index 7941785ab..9b53163fe 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -18,5 +18,15 @@ specific version that you used. We also encourage you to cite the software DOI
 in the main text wherever appropriate. DOIs and BibTeX keys for each release
 can be found on Zenodo_.
 
+  .. only :: builder_html
+
+     .. container:: sphx-glr-footer
+        :class: sphx-glr-footer-gallery
+
+      .. container:: sphx-glr-download sphx-glr-download-python
+
+         :download:`Download BibTeX <main.bib>`
+
+
 .. _Amara et al. (2021): https://doi.org/10.21105/joss.03056
 .. _Zenodo: https://zenodo.org/record/3755531
diff --git a/main.bib b/main.bib
new file mode 100644
index 000000000..84874c76c
--- /dev/null
+++ b/main.bib
@@ -0,0 +1,22 @@
+@article{Amara2021,
+  doi = {10.21105/joss.03056},
+  url = {https://doi.org/10.21105/joss.03056},
+  year = {2021},
+  publisher = {The Open Journal},
+  volume = {6},
+  number = {65},
+  pages = {3056},
+  author = {Adam Amara and Lucia F. de la Bella and Simon Birrer and Sarah Bridle and Juan Pablo Cordero and Ginevra Favole and Ian Harrison and Ian W. Harry and William G. Hartley and Coleman Krawczyk and Andrew Lundgren and Brian Nord and Laura K. Nuttall and Richard P. Rollins and Philipp Sudek and Sut-Ieng Tam and Nicolas Tessore and Arthur E. Tolley and Keiichi Umetsu and Andrew R. Williamson and Laura Wolz},
+  title = {`SkyPy`: A package for modelling the Universe},
+  journal = {Journal of Open Source Software}
+}
+
+@misc{skypy_collaboration_2020_3755531,
+  author= {{SkyPy Collaboration}},
+  title= {SkyPy},
+  month= apr,
+  year= 2020,
+  publisher= {Zenodo},
+  doi= {10.5281/zenodo.3755531},
+  url= {https://zenodo.org/record/3755531}
+}

From 0f52a9c0d82e7d1fb765264c0e0e4b7a40434ee0 Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Fri, 10 Sep 2021 15:21:46 +0100
Subject: [PATCH 06/20] Fix external link

---
 CITATION.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/CITATION.rst b/CITATION.rst
index 9b53163fe..d6c5c48e9 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -5,7 +5,7 @@ If you use SkyPy for work or research presented in a publication (whether
 directly, or as a dependency to another package) we recommend and encourage
 the citation to the following paper in the main text (wherever appropriate):
 
-  Amara et al. (2021)_ Amara et al., (2021). SkyPy: A package for modelling the Universe.
+  `Amara et al., (2021)`_. SkyPy: A package for modelling the Universe.
   Journal of Open Source Software, 6(65), 3056.
 
 and the following acknowledgment:
@@ -28,5 +28,5 @@ can be found on Zenodo_.
          :download:`Download BibTeX <main.bib>`
 
 
-.. _Amara et al. (2021): https://doi.org/10.21105/joss.03056
+.. _Amara et al., (2021): https://doi.org/10.21105/joss.03056
 .. _Zenodo: https://zenodo.org/record/3755531

From 5554702ab227fd506d4b94342095f2ba10aa4e18 Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Fri, 10 Sep 2021 15:28:25 +0100
Subject: [PATCH 07/20] Move citation from developer to project doc folder

---
 docs/{developer => project}/citation.rst | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename docs/{developer => project}/citation.rst (100%)

diff --git a/docs/developer/citation.rst b/docs/project/citation.rst
similarity index 100%
rename from docs/developer/citation.rst
rename to docs/project/citation.rst

From 8106e3ef50eda3ddc79b8f1ae5b7ebb906303383 Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Fri, 10 Sep 2021 15:29:16 +0100
Subject: [PATCH 08/20] Add citatio to the project toctree in index

---
 docs/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/index.rst b/docs/index.rst
index 89db66ab5..a5dce0818 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -76,6 +76,7 @@ Project details
    :maxdepth: 1
 
    project/code_of_conduct
+   project/citation
 
 
 *****

From a66e6c302b870ffd58469a7e8b638c232fa63f1e Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Fri, 10 Sep 2021 15:32:15 +0100
Subject: [PATCH 09/20] Fix link to citation file

---
 docs/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/index.rst b/docs/index.rst
index a5dce0818..069bb9602 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -12,7 +12,7 @@ pipeline.
 
 .. Important:: If you use SkyPy for work presented in a publication or talk
    please help the project via proper :doc:`citation or acknowledgement
-   <developer/citation>`.
+   <project/citation>`.
 
 
 

From 6019b133a63e003340f194f3830acf955951e2fc Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Fri, 10 Sep 2021 15:36:37 +0100
Subject: [PATCH 10/20] Add blank line

---
 CITATION.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/CITATION.rst b/CITATION.rst
index d6c5c48e9..84d939e10 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -1,6 +1,7 @@
 Citation Guidelines
 ===================
 
+
 If you use SkyPy for work or research presented in a publication (whether
 directly, or as a dependency to another package) we recommend and encourage
 the citation to the following paper in the main text (wherever appropriate):
@@ -18,7 +19,7 @@ specific version that you used. We also encourage you to cite the software DOI
 in the main text wherever appropriate. DOIs and BibTeX keys for each release
 can be found on Zenodo_.
 
-  .. only :: builder_html
+  .. only:: builder_html
 
      .. container:: sphx-glr-footer
         :class: sphx-glr-footer-gallery

From bdb2de0d5d4a5e8c459a99026fb3af68304d6357 Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Fri, 10 Sep 2021 15:50:46 +0100
Subject: [PATCH 11/20] Fix link to bib file

---
 CITATION.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CITATION.rst b/CITATION.rst
index 84d939e10..92c7bfd5b 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -26,7 +26,7 @@ can be found on Zenodo_.
 
       .. container:: sphx-glr-download sphx-glr-download-python
 
-         :download:`Download BibTeX <main.bib>`
+         :download:`Download BibTeX <../../main.bib>`
 
 
 .. _Amara et al., (2021): https://doi.org/10.21105/joss.03056

From be1673dc49f1c2bb6ec77dcf1ad1ecbb8a0f6872 Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Mon, 13 Sep 2021 09:42:29 +0100
Subject: [PATCH 12/20] Delete BibTeX file

---
 main.bib | 22 ----------------------
 1 file changed, 22 deletions(-)
 delete mode 100644 main.bib

diff --git a/main.bib b/main.bib
deleted file mode 100644
index 84874c76c..000000000
--- a/main.bib
+++ /dev/null
@@ -1,22 +0,0 @@
-@article{Amara2021,
-  doi = {10.21105/joss.03056},
-  url = {https://doi.org/10.21105/joss.03056},
-  year = {2021},
-  publisher = {The Open Journal},
-  volume = {6},
-  number = {65},
-  pages = {3056},
-  author = {Adam Amara and Lucia F. de la Bella and Simon Birrer and Sarah Bridle and Juan Pablo Cordero and Ginevra Favole and Ian Harrison and Ian W. Harry and William G. Hartley and Coleman Krawczyk and Andrew Lundgren and Brian Nord and Laura K. Nuttall and Richard P. Rollins and Philipp Sudek and Sut-Ieng Tam and Nicolas Tessore and Arthur E. Tolley and Keiichi Umetsu and Andrew R. Williamson and Laura Wolz},
-  title = {`SkyPy`: A package for modelling the Universe},
-  journal = {Journal of Open Source Software}
-}
-
-@misc{skypy_collaboration_2020_3755531,
-  author= {{SkyPy Collaboration}},
-  title= {SkyPy},
-  month= apr,
-  year= 2020,
-  publisher= {Zenodo},
-  doi= {10.5281/zenodo.3755531},
-  url= {https://zenodo.org/record/3755531}
-}

From c3dc091e429c78c5c390a0de98869880f1387a53 Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Mon, 13 Sep 2021 09:44:57 +0100
Subject: [PATCH 13/20] Update text

---
 CITATION.rst | 34 ++++++++++------------------------
 1 file changed, 10 insertions(+), 24 deletions(-)

diff --git a/CITATION.rst b/CITATION.rst
index 92c7bfd5b..f40b8d2ed 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -1,33 +1,19 @@
 Citation Guidelines
 ===================
 
+[![JOSS](https://joss.theoj.org/papers/10.21105/joss.03056/status.svg)](https://doi.org/10.21105/joss.03056) [![Zenodo](https://zenodo.org/badge/doi/10.5281/zenodo.4475347.svg)](https://doi.org/10.5281/zenodo.3755531)
 
 If you use SkyPy for work or research presented in a publication (whether
-directly, or as a dependency to another package) we recommend and encourage
-the citation to the following paper in the main text (wherever appropriate):
-
-  `Amara et al., (2021)`_. SkyPy: A package for modelling the Universe.
-  Journal of Open Source Software, 6(65), 3056.
-
-and the following acknowledgment:
+directly, or as a dependency of another package) we recommend and encourage
+the following acknowledgment:
 
   This research made use of SkyPy, a Python package for forward modeling
-  astronomical surveys (SkyPy Collaboration, 2020).
-
-where (SkyPy Collaboration, 2020) is a citation to the software DOI for the
-specific version that you used. We also encourage you to cite the software DOI
-in the main text wherever appropriate. DOIs and BibTeX keys for each release
-can be found on Zenodo_.
-
-  .. only:: builder_html
-
-     .. container:: sphx-glr-footer
-        :class: sphx-glr-footer-gallery
-
-      .. container:: sphx-glr-download sphx-glr-download-python
-
-         :download:`Download BibTeX <../../main.bib>`
+  astronomical surveys (Amara et. al., 2021, SkyPy Collaboration, 202x).
 
+where the citations are to our publication in the `Journal of Open Source
+Software`_ and the `Zenodo DOI`_ for the specific version of the software that
+you used. We also encourage citations within the main text wherever
+appropriate. DOIs and BibTeX keys are available through the links above.
 
-.. _Amara et al., (2021): https://doi.org/10.21105/joss.03056
-.. _Zenodo: https://zenodo.org/record/3755531
+.. _Journal of Open Source Software: https://joss.theoj.org/papers/10.21105/joss.03056
+.. _Zenodo DOI: https://zenodo.org/record/3755531

From b92ae3599e340b4c24ef6d61cf03c5108189b45c Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Mon, 13 Sep 2021 10:03:43 +0100
Subject: [PATCH 14/20] Fix badges

---
 CITATION.rst | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/CITATION.rst b/CITATION.rst
index f40b8d2ed..da2b9a618 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -1,7 +1,8 @@
 Citation Guidelines
 ===================
 
-[![JOSS](https://joss.theoj.org/papers/10.21105/joss.03056/status.svg)](https://doi.org/10.21105/joss.03056) [![Zenodo](https://zenodo.org/badge/doi/10.5281/zenodo.4475347.svg)](https://doi.org/10.5281/zenodo.3755531)
+|JOSS| |Zenodo|
+
 
 If you use SkyPy for work or research presented in a publication (whether
 directly, or as a dependency of another package) we recommend and encourage
@@ -17,3 +18,14 @@ appropriate. DOIs and BibTeX keys are available through the links above.
 
 .. _Journal of Open Source Software: https://joss.theoj.org/papers/10.21105/joss.03056
 .. _Zenodo DOI: https://zenodo.org/record/3755531
+
+
+.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.03056/status.svg
+    :alt: JOSS
+    :scale: 100%
+    :target: https://doi.org/10.21105/joss.03056
+
+.. |Zenodo| image:: https://zenodo.org/badge/doi/10.5281/zenodo.4475347.svg
+    :alt: Zenodo
+    :scale: 100%
+    :target: https://doi.org/10.5281/zenodo.3755531

From d2e45047a289bc21970960d873e0f983cca11c24 Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Mon, 13 Sep 2021 10:09:18 +0100
Subject: [PATCH 15/20] Eliminate unnecessary options for badges

---
 CITATION.rst | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/CITATION.rst b/CITATION.rst
index da2b9a618..f5a45657d 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -21,11 +21,7 @@ appropriate. DOIs and BibTeX keys are available through the links above.
 
 
 .. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.03056/status.svg
-    :alt: JOSS
-    :scale: 100%
     :target: https://doi.org/10.21105/joss.03056
 
 .. |Zenodo| image:: https://zenodo.org/badge/doi/10.5281/zenodo.4475347.svg
-    :alt: Zenodo
-    :scale: 100%
     :target: https://doi.org/10.5281/zenodo.3755531

From 68dfd649b2db7374433fd5957f1fc18dc4082757 Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Mon, 13 Sep 2021 11:50:41 +0100
Subject: [PATCH 16/20] Add admonition

---
 CITATION.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/CITATION.rst b/CITATION.rst
index f5a45657d..5b5b4bf81 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -8,6 +8,8 @@ If you use SkyPy for work or research presented in a publication (whether
 directly, or as a dependency of another package) we recommend and encourage
 the following acknowledgment:
 
+.. admonition:: Acknowledgment
+
   This research made use of SkyPy, a Python package for forward modeling
   astronomical surveys (Amara et. al., 2021, SkyPy Collaboration, 202x).
 

From 4078b4e9c8305ea5ea867346f1ca9a1ee45e5eed Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Mon, 13 Sep 2021 11:56:45 +0100
Subject: [PATCH 17/20] Edit text around the important note

---
 docs/index.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index 069bb9602..5c3513169 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,8 +11,7 @@ intention the simulations can then be compared to data as part of an inference
 pipeline.
 
 .. Important:: If you use SkyPy for work presented in a publication or talk
-   please help the project via proper :doc:`citation or acknowledgement
-   <project/citation>`.
+   please follow our :doc:`citation guidelines <project/citation>`.
 
 
 

From 82a0ba11c1ff5e9561f99da661faccca423ea515 Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Mon, 13 Sep 2021 12:06:34 +0100
Subject: [PATCH 18/20] Edit text

---
 docs/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/index.rst b/docs/index.rst
index 5c3513169..b3d882feb 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,7 +11,7 @@ intention the simulations can then be compared to data as part of an inference
 pipeline.
 
 .. Important:: If you use SkyPy for work presented in a publication or talk
-   please follow our :doc:`citation guidelines <project/citation>`.
+   please follow our :doc:`project/citation`.
 
 
 

From e08e56f2195b66963a82495a6ccaae693f4f9170 Mon Sep 17 00:00:00 2001
From: "Lucia F. de la Bella" <55983939+Lucia-Fonseca@users.noreply.github.com>
Date: Mon, 13 Sep 2021 15:25:49 +0100
Subject: [PATCH 19/20] Change admonition to pull-quite

---
 CITATION.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CITATION.rst b/CITATION.rst
index 5b5b4bf81..e47c44d9a 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -8,7 +8,7 @@ If you use SkyPy for work or research presented in a publication (whether
 directly, or as a dependency of another package) we recommend and encourage
 the following acknowledgment:
 
-.. admonition:: Acknowledgment
+.. pull-quote::
 
   This research made use of SkyPy, a Python package for forward modeling
   astronomical surveys (Amara et. al., 2021, SkyPy Collaboration, 202x).

From 1d7b1adb75451fa930df54f4f078c4cb0a55f78a Mon Sep 17 00:00:00 2001
From: Richard R <58728519+rrjbca@users.noreply.github.com>
Date: Tue, 2 Nov 2021 14:20:24 +0000
Subject: [PATCH 20/20] Update CITATION.rst

---
 CITATION.rst | 2 --
 1 file changed, 2 deletions(-)

diff --git a/CITATION.rst b/CITATION.rst
index e47c44d9a..f5a45657d 100644
--- a/CITATION.rst
+++ b/CITATION.rst
@@ -8,8 +8,6 @@ If you use SkyPy for work or research presented in a publication (whether
 directly, or as a dependency of another package) we recommend and encourage
 the following acknowledgment:
 
-.. pull-quote::
-
   This research made use of SkyPy, a Python package for forward modeling
   astronomical surveys (Amara et. al., 2021, SkyPy Collaboration, 202x).