Add CITATION.cff #10553
Add CITATION.cff #10553
Conversation
Add CITATION.cff file. Closes sphinx-doc#10543. I have tried to add all public members of the sphinx org as authors, with all the information in their Github profile, although most of it is not necessary. Some additional fields could also be added, such as the license type or an abstract. The version and date-released are optional and could be removed. Please, check that there is no missing author that should be credited. It is also possible to credit an entity.
|
@vnmabus the list of authors is https://github.com/sphinx-doc/sphinx/blob/master/AUTHORS -- really we should either include every author, or just list "Sphinx Developers". A |
| version: 5.0.1 | ||
| date-released: 2022-06-02 |
There was a problem hiding this comment.
Can these be evergreen? It would be another thing to update every single release.
| version: 5.0.1 | |
| date-released: 2022-06-02 | |
| version: 5.0.1 |
There was a problem hiding this comment.
They are not required in the latest version of the cff format, but are recommended.
The maintainers recommend having some automation to bump the version and add this file to that procedure (citation-file-format/citation-file-format#383 (comment)). They themselves seemingly use bump2version for this purpose (citation-file-format/citation-file-format#299).
There was a problem hiding this comment.
+1 to add them if the automation will be integrated into our release process. Without that, I'd not like to add them.
Co-authored-by: Adam Turner <[email protected]>
In https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#how-to-deal-with-unknown-individual-authors it is recommended to add as much information as possible about the individual authors to credit them, and use teams/projects as a last "catch all" resource. It is eventually a choice that the maintainers of Scipy should make, as you probably don't want to have repeated information. I will update the PR to reflect that decision once you make it. Note that if in the future the CFF format incorporates some way to define the contribution roles (such as citation-file-format/citation-file-format#112), it could be possible to keep author information in this file alone. |
|
Hi, this PR looks stale. Is the preferred way to cite Sphinx |
|
'The Sphinx Developers, Sphinx: The Sphinx documentation generator, 2007-2023' perhaps for now. I have added the Zenodo integration to create a DOI but that requires a new release (which might happen end of April-ish?). A |
4 participants
Add CITATION.cff file. Closes #10543.
I have tried to add all public members of the sphinx org as authors, with all the information in their Github profile, although most of it is not necessary. Some additional fields could also be added, such as the license type or an abstract.
The version and date-released are optional and could be removed.
Please, check that there is no missing author that should be credited. It is also possible to credit an entity. If there is an additional article or book that should be cited instead it is also possible to add it as a preferred citation.
Subject: Add standard citation.
Feature or Bugfix
Purpose
Detail
Relates