Switch bibliography to use references.bib#908
Conversation
…list to an included catalog.am file
…support editable installs
…outs for catalog games
… files are included
…Docs configurations
… .ef file suffixing
…ngs to the catalog
…:p: citation format
…o primary .ef file exists
…talog documentation
…cumentation references
…ripts in developer documentation
rahulsavani
left a comment
There was a problem hiding this comment.
This is working well and the docs look good, but there is one issue we can hopefully fix:
At the moment, the bib entry I added (which is intentionally a slightly non-standard case) is not coming out ideally. It is a chapter in a book and would ideally come out like:
Shapley, L.S. (1974). A note on the Lemke-Howson algorithm. In: Balinski, M.L. (eds) Pivoting and Extension. Mathematical Programming Studies, vol 1. Springer, Berlin, Heidelberg.
Instead we get:
Shapley, Lloyd S. A note on the Lemke-Howson algorithm, pages 175–189. Springer Berlin Heidelberg, 1974.
It is an "inbook" entry.
Is that easy to fix, probably in the bibtex config?
| } | ||
|
|
||
|
|
||
| @inbook{Shap74, |
There was a problem hiding this comment.
@rahulsavani It looks like the issue was that there were 2 duplicate entries for Shap74 and Sha74 so I've removed the latter and I think this now looks correct:
There was a problem hiding this comment.
That's weird. The other one has key Sha74 (and is wrong). My new one has key Shap74. How could these clash with different keys?!
There was a problem hiding this comment.
They didn't clash, they were previously just next to eachother in the bibliography, so I assumed this was a mistake
There was a problem hiding this comment.
Oh, I see, I was just looking at the wrong entry -- woops! Great, we are good then. Let's merge and I can start creating our hierarchical structure.
* refactor: modularize catalog file management by moving the game file list to an included catalog.am file * Step 3 is not optional * Clarify docs building * docs: update development guide and update catalog path resolution to support editable installs * fix indentation * docs: correct code block language hint for editable install instructions * docs: clarify when to use developer install in catalog dev doc * refactor: migrate game visualisation parameters to external YAML configuration file * feat: allow curated .ef files to override auto-generated DrawTree layouts for catalog games * feat: update catalog image display to support curated EF files when present * Update comments and add help to args for update.py * refactor: improve catalog game loading ensure only proper EFG and NFG files are included * test: add suite for catalog update logic and update test dependencies * nicer formatting of _YAML_CONFIG indents * refactor: update docstrings and comments in catalog update test suite * fix: use as_posix() for cross-platform slug path consistency in catalog updates * chore: update draw-tree dependency to version 0.9.1 in CI and ReadTheDocs configurations * feat: enable support for multiple game layout variants in catalog via .ef file suffixing * feat: re-add new vonstengel2022 game files and custom draw tree settings to the catalog * refactor: migrate bibliography and catalog references to Sphinx :cite:p: citation format * feat: migrate download links to dropdown * feat: support efg tab sets for games with suffix variants even when no primary .ef file exists * Add gilboa1997/fig1 to catalog.am * update link for gilboa1997/fig1.efg * Update action_label_dist for gilboa1997 * fix: resolve syntax error in docstring citation for Gilboa 1997 catalog entry * docs: add guide for updating the bibliography and link it from the catalog documentation * fix: correct volume number for Reiley et al. citation in references.bib * feat: implement custom keystyle bibliography label and apply it to documentation references * feat: implement custom BibTeX formatting style with dash support in conf.py * docs: clarify bibliography formatting and the use of custom Python scripts in developer documentation * refactor: rename bibliography categories to articles_equilibria and articles_general * original layout efs for figs 6 and 9 of vonstengelforges2008 * chore: remove f9-ff.ef from catalog build support files * shapley1974 * docs: update Shapley author format and add inbook template support to bibliography processor * De-duplicate Shap74 in bib * revert unnecessary func --------- Co-authored-by: Rahul Savani <rahul.savani@gmail.com>
Issues closed by this PR
Description of the changes in this PR
This PR makes it easy to update the bibliography via the new
references.bibwhich works with thesphinxcontrib-bibtexpackage.conf.pywith the BibTeX configuration, which includes a custom style class - this was necessary to replicate our Harvard style formattingshapley1974games to the catalogHow to review this PR