Repository navigation
[Bug]: Warnings when making html #1051
Description
Where did you find this bug?
Gambit CLI
What operating system are you using?
macOS
What version of Gambit are you using?
16.7.0
What happened?
I observed the following warnings when I made html:
/Users/wangyzh/UNFProjects/gambit/doc/gui.rst:7: WARNING: Failed to create a cross reference. A title or caption not found: 'install-cli-gui' [ref.ref]
/Users/wangyzh/UNFProjects/gambit/doc/tools.rst:7: WARNING: Failed to create a cross reference. A title or caption not found: 'install-cli-gui' [ref.ref]
/Users/wangyzh/UNFProjects/gambit/doc/tools.enumpoly.rst:48: WARNING: undefined label: 'pygambit-nash-maxregret' [ref.ref]
/Users/wangyzh/UNFProjects/gambit/doc/tools.liap.rst:65: WARNING: undefined label: 'pygambit-nash-maxregret' [ref.ref]
/Users/wangyzh/UNFProjects/gambit/doc/tools.logit.rst:46: WARNING: undefined label: 'pygambit-nash-maxregret' [ref.ref]
/Users/wangyzh/UNFProjects/gambit/doc/tools.simpdiv.rst:62: WARNING: undefined label: 'pygambit-nash-maxregret' [ref.ref]
/Users/wangyzh/UNFProjects/gambit/doc/tutorials/advanced_tutorials/quantal_response.ipynb:284: WARNING: undefined label: '/tutorials/advanced_tutorials/quantal_response.ipynb#f1' [ref.ref]
Maybe they were raised by the development of other parts of gambit. So just put this as a record here.
Activity
r4-rahul123 commentedon Aug 29, 2026
Hi, I would like to work on this issue.
I have reproduced the warnings (install-cli-gui and pygambit-nash-maxregret missing refs + quantal_response.ipynb#f1) and have a fix ready for doc/install.rst, doc/pygambit.rst and doc/tutorials/advanced_tutorials/quantal_response.ipynb. Could you please assign this issue to me? Thank you!
Wombatfreak6 commentedon Sep 9, 2026
Adding some context on the root cause in case it's useful for whoever works on this.
The
pygambit-nash-maxregretlabel is defined — it lives at line 25 ofdoc/algorithms.rstas.. _pygambit-nash-maxregret:. The undefined-label warnings intools.enumpoly.rst,tools.liap.rst,tools.logit.rst, andtools.simpdiv.rstare almost certainly a side effect of the CLI migration in #1085, which moved the command-line tools from C++ topygambit. The cross-references in thosetools.*.rstfiles were written when the tools docs andalgorithms.rstwere part of the same Sphinx build scope; if the reorganisation shifted their location in the toctree, Sphinx may no longer be resolving the intersphinx/cross-doc reference correctly.The
gui.rst:7andtools.rst:7"failed to create a cross reference" warnings look like a separate issue — probably a:ref:or:doc:at the top of those files pointing to a target that was renamed or moved during the same migration.Happy to take a look and open a fix if @r4-rahul123's PR hasn't landed yet — just let me know.
tturocy commentedon Sep 11, 2026
Thank you for looking at these, but actually they are already dealt with by other documentation re-writing that is going on.