Skip to content

Switch bibliography to use references.bib#908

Merged
edwardchalstrey1 merged 44 commits into
masterfrom
fix/900
Jun 2, 2026
Merged

Switch bibliography to use references.bib#908
edwardchalstrey1 merged 44 commits into
masterfrom
fix/900

Conversation

@edwardchalstrey1

@edwardchalstrey1 edwardchalstrey1 commented Jun 1, 2026

Copy link
Copy Markdown
Member

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.bib which works with the sphinxcontrib-bibtex package.

  • Updates all the docs and game files that reference the bibliography
  • Updates the conf.py with the BibTeX configuration, which includes a custom style class - this was necessary to replicate our Harvard style formatting
  • Updates the docs with "Updating the Bibliography" which we lacked previously
  • Also adds shapley1974 games to the catalog

How to review this PR

@edwardchalstrey1 edwardchalstrey1 marked this pull request as ready for review June 1, 2026 13:29

@rahulsavani rahulsavani left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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?

Comment thread doc/references.bib
}


@inbook{Shap74,

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@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:

Image

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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?!

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

They didn't clash, they were previously just next to eachother in the bibliography, so I assumed this was a mistake

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

@rahulsavani rahulsavani left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good to me.

@edwardchalstrey1 edwardchalstrey1 merged commit 09b5f0d into master Jun 2, 2026
26 checks passed
@edwardchalstrey1 edwardchalstrey1 deleted the fix/900 branch June 2, 2026 15:14
d-kad pushed a commit to d-kad/gambit that referenced this pull request Jun 3, 2026
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bibtex-based bibliography in the docs

2 participants