[nataliemes]

Main changes

#26 mentioned two separate pages: getting started (tutorials) and worked examples, but since they had overlapping content, I decided to make one dedicated place for tutorials. There are three new tutorial pages for:

1. solving LCPs,
2. finding equilibria for bimatrix games,
3. visualizing random priors on a simplex (randomstart module).

You can view them here.

Also, I thought the CLI examples should be included in the CLI page (which I will add shortly), therefore these tutorials show only the library usage examples.

Let me know if you think another way of organizing examples/tutorials is better.

Other related changes

• Since some doctests were failing due to the difference in trailing whitespaces, columnprint.py was updated to strip the whitespaces at the end of the strings.
• In lemke.py, the PrintingCallback constructor used stream=sys.stdout as a default argument. Python evaluates defaults once at definition time, so the callback kept a reference to the original stdout from import time. Anything that later replaced sys.stdout (like doctest) was silently bypassed, so the output reached the real console but was not captured, therefore doctests saw empty output.
  The default was changed to None and sys.stdout is resolved when the stream is used (so the current sys.stdout is respected).

[Copilot]

🟡 Changes recommended

Default doctest collection includes API examples with missing input files, causing the doctest build to fail.

4 open issues

• Prevent doctest failures from missing input files · New
• Link to bimatrix.from_file documentation · New
• Document integer and Fraction input support · New
• Fix broken file_formats documentation link · New

What changed in this PR

Adds library-focused tutorials alongside the API documentation, covering LCP solving, bimatrix equilibria, and random-prior visualization.

Changes:

• Adds three tutorials and documentation navigation.
• Enables doctests and embedded plots.
• Adjusts output formatting and callback stream initialization.

File	Description
src/​lemke/​lemke.py	Resolves default stdout when constructing callbacks.
src/​lemke/​columnprint.py	Removes trailing output whitespace.
examples/​lcp_2x2	Adds tutorial input data.
doc/​tutorials/​randomstart.rst	Explains simplex sampling and visualization.
doc/​tutorials/​lcp.rst	Demonstrates solving LCPs and using callbacks.
doc/​tutorials/​index.rst	Organizes tutorial navigation.
doc/​tutorials/​bimatrix.rst	Demonstrates equilibrium-finding methods.
doc/​index.rst	Links tutorials from the documentation homepage.
doc/​conf.py	Enables doctests and configures plots.

_{Review effort: Balanced}

[rahulsavani]

Again, this looks good to me, just a few thing copilot picked up to deal with.

[Copilot]

🟢 Approval recommended

Only a minor documented-output mismatch remains, with no blocking issues identified.

1 open issue

• Update output to match plot_simplex arguments · New

4 resolved since last review

• Prevent doctest failures from missing input files
• Fix broken file_formats documentation link
• Document integer and Fraction input support
• Link to bimatrix.from_file documentation

_{Review effort: Balanced}

[rahulsavani]

Looks good to me, I just made one minor edit.