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

DOC: Fix for side bar rendering on top of text issue #18189

Merged
merged 3 commits into from
Mar 24, 2023

Conversation

harshvardhan2707
Copy link
Contributor

@harshvardhan2707 harshvardhan2707 commented Mar 22, 2023

Reference issue

closes #17532

What does this implement/fix?

Fixes the overlapping text and sidebar issue

Additional information

Screenshot of issue
image

[skip azp] [skip actions] [skip cirrus]

@j-bowhay j-bowhay added scipy.optimize Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Mar 22, 2023
@tupui
Copy link
Member

tupui commented Mar 22, 2023

Thank you @harshvardhan2707, we will have a look shortly.

@j-bowhay that could be a good start 😃 (we could use this PR to go over things.) Just FYI @harshvardhan2707, we are on-boarding Jake as a new maintainer, nothing to be concerned on your side.

Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

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

Thanks @harshvardhan2707, this is pretty close just two changes are required:

  1. You have changed the wrong matrix, the change should be on line 291 instead
  2. The indented needs fixing eg. \mathbf{H} and begin{bmatrix} and subsequent lines should be on the same level of indentation. This will fix the rendering.

Two further things to keep in mind for the future:

  • If possible try to skip CI that is not required (see https://docs.scipy.org/doc/scipy/dev/contributor/continuous_integration.html#skipping). In this case, as this is a doc-only change we don't need to run the whole test suite so you can add [skip azp] [skip actions] [skip cirrus] to the end of the commit message
  • You have made your changes in your main branch. This is fine for this PR but it will cause you unnecessary headaches in the future if you wish to continue contributing

Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

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

Thanks @harshvardhan2707 LGTM, refguide failure is unrelated. Keep them coming!

@j-bowhay j-bowhay merged commit d799631 into scipy:main Mar 24, 2023
@j-bowhay j-bowhay added this to the 1.11.0 milestone Mar 24, 2023
doronbehar added a commit to doronbehar/scipy that referenced this pull request Mar 27, 2023
* main: (52 commits)
  ENH: stats.vonmises.fit: treat case in which location likelihood equation has no solution(scipy#18190)
  MAINT: stats.kendalltau: avoid overflow (scipy#18193)
  DOC: Optimize: Fix for side bar rendering on top of Hessian (scipy#18189)
  MAINT: optimize.linprog: fix bound checks for integrality > 1 (scipy#18160)
  MAINT: Windows distutils cdist/pdist shims (scipy#18169)
  BUG: interpolate: add x-y length validation for `make_smoothing_spline`. (scipy#18188)
  ENH: Added `_sf` method for anglit distribution (scipy#17832) (scipy#18178)
  DOC: Fixed missing curly bracket in scipy.css
  DOC: Improving wording and docs for legacy directive
  DOC: Move legacy directive to not be first in the file
  DOC: Legacy directive custom styling
  DOC: Add optional argument to Legacy directive
  DOC: Ignore legacy directive in refguide_check
  DOC: Documenting the usage of the legacy directive
  DOC: Add legacy directive for documentation
  MAINT: stats.ecdf: store number at risk just before events (scipy#18187)
  DOC: cite pip issue about multiple `--config-settings` (scipy#18174)
  DOC: update links for ARPACK to point to ARPACK-NG (scipy#18173)
  MAINT: stats.logistic.fit: simplify
  MAINT: optimize.root_scalar: return gracefully when callable returns NaN (scipy#18172)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.optimize
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: side bar renders over the top of some of the text in the optimize tutorial
3 participants