Skip to content

Conversation

oscarbenjamin
Copy link
Collaborator

Backport of #23669 for the 1.11 branch.

  • other
    • Clean up the top-level organization in the documentation.

asmeurer and others added 5 commits July 17, 2022 12:18
- Use better summaries of the top level sections on the index page based on
  Diataxis.

- Move the contributing guides into their own section. Potentially the getting
  started can also be its own section, although right now that's just the
  installation.

- Made tutorials a section which can hold many tutorials. The current
  introductory tutorial is just one such tutorial. We may also want to split
  it into many tutorials.

- Renamed "explanation" into "explanations" (but I did not change the
  directory name).

- Redirects were added for all moved pages.

- Fix some existing redirects. The redirect paths are supposed to be relative
  to the redirected page. The reredirects extension does not test if a
  redirect is valid.
That way we can't accidentally reference something from matplotlib.
@sympy-bot
Copy link

sympy-bot commented Jul 17, 2022

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

Your release notes are in good order.

Here is what the release notes will look like:

This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.11.

Click here to see the pull request description that was parsed.
Backport of #23669 for the 1.11 branch.

<!-- BEGIN RELEASE NOTES -->
- other
  - Clean up the top-level organization in the documentation.
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

@sympy-bot
Copy link

🟠

Hi, I am the SymPy bot (v167). I've noticed that some of your commits add or delete files. Since this is sometimes done unintentionally, I wanted to alert you about it.

This is an experimental feature of SymPy Bot. If you have any feedback on it, please comment at sympy/sympy-bot#75.

The following commits add new files:

  • 9d2d11f:
    • doc/src/contributing/index.rst
    • doc/src/tutorials/intro-tutorial/next.rst
  • be2b7a6:
    • doc/src/tutorials/index.rst

The following commits delete files:

  • 9d2d11f:
    • doc/src/guides/contributing/index.rst
    • doc/src/tutorial/next.rst
  • caa27ea:
    • doc/src/guides/getting_started/index.rst

If these files were added/deleted on purpose, you can ignore this message.

@oscarbenjamin oscarbenjamin added Documentation CZI: Documentation Issues and pull requests relating to Aaron Meurer's CZI grant documentation project labels Jul 17, 2022
@oscarbenjamin oscarbenjamin added this to the SymPy 1.11 milestone Jul 17, 2022
@oscarbenjamin oscarbenjamin mentioned this pull request Jul 17, 2022
44 tasks
@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
     [77f1d79c]       [1f918020]
     <sympy-1.10.1^0>                 
+      27.2±0.7μs         85.2±4μs     3.13  matrices.TimeMatrixExpression.time_MatAdd
+         124±3ms          218±6ms     1.75  sum.TimeSum.time_doit

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

@oscarbenjamin oscarbenjamin merged commit c4b4c2a into sympy:1.11 Jul 17, 2022
@oscarbenjamin oscarbenjamin deleted the pr_doc_org_backport branch July 17, 2022 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CZI: Documentation Issues and pull requests relating to Aaron Meurer's CZI grant documentation project Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants