Internal API reference: sympy.abc

[nanjekyejoannah]

This PR adds docs for the Private API reference section and specifically the sympy.abc module.

References to other Issues or PRs

#22105

Brief description of what is fixed or changed

The docs in the directories modules have been re-categorized, see Categorize SymPy Modules

Other comments

Release Notes

NO ENTRY

[sympy-bot]

✅

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. -->

This PR adds docs for the ``Private API reference `` section and specifically the ``sympy.abc`` module.

#### 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. -->

https://github.com/sympy/sympy/issues/22105

#### Brief description of what is fixed or changed

The docs in the directories ``modules`` have been re-categorized, see [Categorize SymPy Modules](https://github.com/sympy/sympy/issues/22006)


#### 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 -->

[sympy-bot]

🟠

Hi, I am the SymPy bot (v162). 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:

• 20f535c:
  • doc/src/_templates/custom-class-template.rst
  • doc/src/_templates/custom-module-template.rst
  • doc/src/reference/private/index.rst
  • doc/src/reference/private/sympy.abc.rst

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

[nanjekyejoannah]

This is the first iteration of the internal reference as agreed on in #22105, we can use this PR to discuss the final design of docs in this category.

[asmeurer]

Can you update the installation instructions? I tried installing autoapi but it still told me it couldn't find the extension.

[asmeurer]

This is generating rst files with the docstrings. We should use sphinx-apidoc instead, which will generate files with autodoc references. We will need to add :noindex: to the templates. We will also need to fix any RST issues with a bunch of docstrings.

[nanjekyejoannah]

Let's discuss this some more tomorrow. Complete automation does not seem possible to me, I am having to edit the generated files to fix package imports where autoapi assumes folders are packages which is not the case. Plus what @asmeurer mentions too. It will take me another weekend to fix everything including doc strings etc.

[github-actions]

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)

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