Skip to content

Add CITATION.cff #10553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Add CITATION.cff #10553

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f59c799
Add CITATION.cff
vnmabus Jun 14, 2022
3bdc2d4
Apply suggestions from code review
vnmabus Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Brandl
given-names: Georg
alias: birkenfeld
email: [email protected]
affiliation: FZ Jülich
city: München
country: DE
- family-names: Shimizukawa
given-names: Takayuki
alias: shimizukawa
email: [email protected]
website: "http://about.me/shimizukawa"
city: Tokyo
country: JP
- family-names: Komiya
given-names: Takeshi
alias: tk0miya
email: [email protected]
city: Saitama
country: JP
- family-names: Kampik
given-names: Timotheus
alias: TimKam
orcid: "https://orcid.org/0000-0002-6458-2252"
website: "people.cs.umu.se/tkampik"
title: "Sphinx: Python Documentation Generator"
version: 5.0.1
date-released: 2022-06-02
Comment on lines +30 to +31
Copy link
Member

@AA-Turner AA-Turner Jun 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can these be evergreen? It would be another thing to update every single release.

Suggested change
version: 5.0.1
date-released: 2022-06-02
version: 5.0.1

Copy link
Author

@vnmabus vnmabus Jun 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Member

@tk0miya tk0miya Jun 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to add them if the automation will be integrated into our release process. Without that, I'd not like to add them.

url: "https://github.com/sphinx-doc/sphinx"