@@ -70,6 +70,59 @@ the ``docs/readthedocs.org:pvlib-python`` link within the checks
7070status box at the bottom of the pull request.
7171
7272
73+ .. _references :
74+
75+ References
76+ ----------
77+ All pertinent information within a docstring should include a proper reference.
78+ In pvlib-python, we are transitioning to a standardised referencing system. We
79+ encourage using the `IEEE style <https://journals.ieeeauthorcenter.ieee.org/wp-content/uploads/sites/7/IEEE_Reference_Guide.pdf >`_
80+ with numeric in-text citations, but overall the most important feature of all
81+ references is that they include sufficient information to make locating the
82+ original source as easy as possible. As a bare minimum, we advise including:
83+
84+ XXX ok to link a pdf? originally from `this page <https://ieeeaccess.ieee.org/guide-for-authors/preparing-your-article/ >`_
85+
86+ * Author list (can be abbreviated with et al.)
87+ * Publication title
88+ * Publication source (journal title, laboratory name, etc.)
89+ * Year of publication
90+ * DOI (if available) XXX "or other link"? but don't want to encourage too many
91+ non-permanent URLs that may break at a later date though
92+
93+ For journal articles, the recommended style citation is as follows:
94+
95+ Author initials. Author Surname, "Title of article," abbreviated journal
96+ title, vol. number, issue number, page numbers, Abbreviated Month Year.
97+
98+ The example below shows how to cite material and generate a reference list
99+ using the IEEE style in a docstring::
100+
101+ This is the recommended citation for the pvlib-python project [1]_. There
102+ are also some conference papers linked to pvlib, for example [2]_.
103+
104+ References
105+ ----------
106+ .. [1] K. Anderson, C. Hansen, W. Holmgren, A. Jensen, M. Mikofski,
107+ and A Driesse. “pvlib python: 2023 project update.” J. Open Source
108+ Softw. 8(92), 5994, (2023). :doi:`10.21105/joss.05994`.
109+
110+ .. [2] J. S. Stein, “The Photovoltaic Performance Modeling Collaborative
111+ (PVPMC),” In Proc. 38th IEEE Photovoltaic Specialists Conference
112+ (PVSC), Austin, TX, USA, 2012, pp. 3048-3052,
113+ :doi:`10.1109/PVSC.2012.6318225`.
114+
115+ Things to note:
116+
117+ * In text numeric citations require a number inside square brackets, followed
118+ by an underscore, e.g. `[1]_ `
119+ * To include a DOI, you can use the existing `Sphinx role <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html >`_,
120+ with the DOI string, e.g. `:doi:10.21105/joss.05994 `.
121+ * The citation formatting must be consistent within the same docstring, for
122+ example if you abbreviate the author list after one author in the first
123+ citation then you should do so in all citations.
124+
125+
73126.. _building-the-documentation :
74127
75128Building the documentation
0 commit comments