Add bibliography to the manual #116
Conversation
The custom citation style is copied from OSCAR and basically ensures that the exact citation keys are used that we prescribe in the .bib file. Citation keys are instead managed via `bibtool`. To this end, the helper script `etc/format_bib` can be run from the root directory of this package to reformat `docs/src/refs.bib` in a consistent way. If a custom citation key is desired, one can add a `bibkey` field.
| @@ -0,0 +1,38 @@ | |||
| # | |||
| # This file is included by docs/make_work.jl to define the custom citation style `oscar_style`. | |||
There was a problem hiding this comment.
@lgoettgens I think you wrote this file -- I copied it from Oscar.jl, but there is no mention of you. I'd be happy to add a copyright notice or whatever, let me know if you have a concrete suggestion. Or we leave it as-is, whichever you prefer.
(Both packages are under the same license, so that bit at least should be fine)
There was a problem hiding this comment.
Hmm, what about something like the following?
Copyright (c) 2023 Lars Göttgens, The OSCAR Development Team
This file was copied from https://github.com/oscar-system/Oscar.jl version 1.1.0
I think that referencing the Oscar repository is the most important thing here.
But then we should do something similar for the other file that you copied: .bibtoolrsc. Either with 2021-2023 and both our names (according to its history https://github.com/oscar-system/Oscar.jl/commits/master/.bibtoolrsc), or I would be fine with just The OSCAR Development Team instead of individual names. And again add a reference to the Oscar repo, in the same style as for the other file.
Thanks a lot for thinking about such things!
There was a problem hiding this comment.
Resolved.
Though I personally really don't want to claim copyright on a simple config file like .bibtoolrsc.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #116 +/- ##
==========================================
+ Coverage 71.03% 80.75% +9.72%
==========================================
Files 10 10
Lines 901 904 +3
==========================================
+ Hits 640 730 +90
+ Misses 261 174 -87 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Besides the changes @lgoettgens suggested I don't see any other issues.
Co-authored-by: Lars Göttgens <[email protected]>
The custom citation style is copied from OSCAR and basically ensures that the exact citation keys are used that we prescribe in the .bib file.
Citation keys are instead managed via
bibtool. To this end, the helper scriptetc/format_bibcan be run from the root directory of this package to reformatdocs/src/refs.bibin a consistent way. If a custom citation key is desired, one can add abibkeyfield.