Repository navigation
Update the front page in docs - #28
Merged
Merged
Conversation
nataliemes
changed the title
nataliemes
marked this pull request as ready for review
October 20, 2026 21:32
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The Python doctest fails when run from the documentation directory because its input path is relative to the repository root.
3 open issues
What changed in this PR
Expands the documentation front page to introduce lemke and help users get started.
Changes:
- Adds features, Python and CLI examples, installation guidance, and citation information.
- Adds a small LCP example input.
- Enables Sphinx doctests and mathematical rendering, and preserves full URLs.
| File | Description |
|---|---|
examples/lcp_2x2 |
Adds input for the Python example. |
doc/index.rst |
Expands introductory and getting-started documentation. |
doc/conf.py |
Enables doctest and MathJax extensions and adjusts URL display. |
Review effort: Balanced
rahulsavani
requested changes
Oct 21, 2026
rahulsavani
left a comment
rahulsavani
left a comment
Member
There was a problem hiding this comment.
Basically this looks good to me. Copilots comments seem reasonable to please respond to them -- fine to just commit them if you agree they make sense.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Expanded the docs front page following the outline in #26.
You can view the updated front page here.
It now contains: