Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

web documentation updates #1731

Merged
merged 2 commits into from
Apr 3, 2022

Conversation

rileyjmurray
Copy link
Collaborator

@rileyjmurray rileyjmurray commented Apr 2, 2022

This resolves #1710 and #1713. I also added material that explains the precise meaning of "atom" in cvxpy's code base, slightly changed some text formatting, and moved a bit of content around within a single .rst file.

This PR is pulling into the release/1.2.x branch. If merged, then I'll tag the commit with "doc1.2.0-update" (currently the name of this branch) and manually trigger a doc build with GitHub actions. The build will happen with the unreleased version of 1.2.1, which is functionally equivalent to 1.2.0 (the only difference is version flags in setup.py). I made a change to sphinx's conf.py to make sure the patch number doesn't appear in metadata for the web documentation.

Once web docs are fixed on this branch I'll propagate changes to master.

Copy link
Collaborator

@SteveDiamond SteveDiamond left a comment

Choose a reason for hiding this comment

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

LGTM. There appear to be unrelated errors with the GLOP and PDLP interfaces.

@rileyjmurray rileyjmurray merged commit c8d61fa into cvxpy:release/1.2.x Apr 3, 2022
@rileyjmurray
Copy link
Collaborator Author

Well, the deployment worked, but then I noticed that real and imag aren't in the main table of atomic functions: https://www.cvxpy.org/tutorial/functions/index.html. I'll fix that.

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.

None yet

2 participants