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

documentation: Correct Next topic link for last page in documentation's Tutorial, Guides #22709

Merged
merged 1 commit into from
Dec 19, 2021

Conversation

bertiewooster
Copy link
Contributor

References to other Issues or PRs

Fixes #22652

Brief description of what is fixed or changed

Changed order of items in (hidden) toctree on top-level page to agree with order displayed on the page:
tutorial
guides
explanation
reference
miscellaneous (not displayed on page, so putting last)

Other comments

Release Notes

NO ENTRY

tutorial
guides
explanation
reference
miscellaneous
@sympy-bot
Copy link

Hi, I am the SymPy bot (v162). I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

  • No release notes entry will be added for this pull request.
Click here to see the pull request description that was parsed.
<!-- Your title above should be a short description of what
was changed. Do not include the issue number in the title. -->

#### References to other Issues or PRs
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234" (see
https://tinyurl.com/auto-closing for more information). Also, please
write a comment on that issue linking back to this pull request once it is
open. -->
Fixes #22652

#### Brief description of what is fixed or changed
Changed order of items in (hidden) toctree on [top-level page](https://docs.sympy.org/dev/) to agree with order displayed on the page:
tutorial
guides
explanation
reference
miscellaneous (not displayed on page, so putting last)

#### Other comments


#### Release Notes

<!-- Write the release notes for this release below between the BEGIN and END
statements. The basic format is a bulleted list with the name of the subpackage
and the release note for this PR. For example:

* solvers
  * Added a new solver for logarithmic equations.

* functions
  * Fixed a bug with log of integers.

or if no release note(s) should be included use:

NO ENTRY

See https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more
information on how to write release notes. The bot will check your release
notes automatically to see if they are formatted correctly. -->

<!-- BEGIN RELEASE NOTES -->
NO ENTRY
<!-- END RELEASE NOTES -->

@bertiewooster bertiewooster changed the title Correct Next topic link for last page in documentation's Tutorial, Guides documentation: Correct Next topic link for last page in documentation's Tutorial, Guides Dec 19, 2021
@github-actions
Copy link

Benchmark results from GitHub Actions

Lower numbers are good, higher numbers are bad. A ratio less than 1
means a speed up and greater than 1 means a slowdown. Green lines
beginning with + are slowdowns (the PR is slower then master or
master is slower than the previous release). Red lines beginning
with - are speedups.

Significantly changed benchmark results (PR vs master)

Significantly changed benchmark results (master vs previous release)

       before           after         ratio
     [907895ac]       [ea9c2c2d]
-      4.82±0.01s          365±2ms     0.08  polygon.PolygonArbitraryPoint.time_bench01
+        3.83±0ms      6.62±0.02ms     1.73  solve.TimeMatrixOperations.time_det(4, 2)
+     3.83±0.01ms      6.68±0.04ms     1.75  solve.TimeMatrixOperations.time_det_bareiss(4, 2)
+      43.3±0.4ms       80.8±0.4ms     1.87  solve.TimeMatrixSolvePyDySlow.time_linsolve(1)
+      44.0±0.4ms       81.4±0.6ms     1.85  solve.TimeMatrixSolvePyDySlow.time_solve(1)

Full benchmark results can be found as artifacts in GitHub Actions
(click on checks at the top of the PR).

@asmeurer asmeurer merged commit 60b926d into sympy:master Dec 19, 2021
@bertiewooster
Copy link
Contributor Author

It's nice that the dev version documentation sub-site updates as soon as code is merged, so we have time to try out the documentation updates before the next SymPy release.

@bertiewooster bertiewooster deleted the 22652_docs_reorder_index branch July 13, 2022 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Correct Next topic link for last page in documentation's Tutorial, Guides
3 participants