move documentation of asymptotic expansion to sage.asymptotic

[dkrenn]

Move documentation from sage/rings/asymptotic to sage/asymptotic

Depends on #19083

CC: @behackl @cheuberg

Component: asymptotic expansions

Author: Daniel Krenn

Branch/Commit: 55ea3a9

Reviewer: Clemens Heuberger

Issue created by migration from https://trac.sagemath.org/ticket/19400

[dkrenn]

Dependencies: #19083

[jdemeyer]

Replying to @dkrenn:

Move code from sage.rings.asymptotic to sage.asymptotic

Why?

[dkrenn]

comment:3

Replying to @jdemeyer:

Replying to @dkrenn:

Move code from sage.rings.asymptotic to sage.asymptotic

Why?

• For this asymptotic expansion project we had to create a separate asymptotic_expansion_index.rst in src/doc/en/reference/rings, which seems a bit unnatural. Including it also was not easily possible. Thus having it in sage.asymptotic will create less unnatural constructions and seems to be more like it should be.

• Also the structure of the reference manual supports this choice: In its main index there is a section on standard rings and fields (sage.rings). The asymptotic expansions definitly do not belong there. The best fit (and a good one as well) is the main calculus section of the reference manual, where it now (since AsymptoticRing: exp & log, cleanup, some improvements, documentation #19083) is.

• SageManifolds metaticket 1 #18528 will live in sage.manifolds as well. There are already projects directly in sage.*, e.g. quivers, quadratic forms, ...

• The asymptotic expansion project not only consist of the AsymptoticRing (public), but there are term monoids and growth groups (but both more private than the ring) as well.

All in all sage.asymptotic seems to be the right choice.

[jdemeyer]

comment:4

Replying to @dkrenn:

• For this asymptotic expansion project we had to create a separate asymptotic_expansion_index.rst in src/doc/en/reference/rings, which seems a bit unnatural.

Why unnatural? We have a separate index in the manual about finite rings for example, but I don't think we should have sage.finite_rings.

• Also the structure of the reference manual supports this choice: In its main index there is a section on standard rings and fields (sage.rings). The asymptotic expansions definitly do not belong there. The best fit (and a good one as well) is the main calculus section of the reference manual, where it now (since AsymptoticRing: exp & log, cleanup, some improvements, documentation #19083) is.

So you should move to sage.calculus.asymptotic or sage.symbolic.asymptotic then...

• SageManifolds metaticket 1 #18528 will live in sage.manifolds as well. There are already projects directly in sage.*, e.g. quivers, quadratic forms, ...

Are those things rings? A manifold and a quadratic form certainly is not a ring, I don't know about quivers.

Asymptotic expansions might not form a ring in the mathematical sense, but it is sufficiently ring-like (just like the symbolic "ring") that it can remain in sage.rings.

• The asymptotic expansion project not only consist of the AsymptoticRing (public), but there are term monoids and growth groups (but both more private than the ring) as well.

How is this relevant?

I think that asymptotic expansions fit nicely next to polynomials for example in sage.rings. I just don't want to end up with 100 subdirectories directly in src/sage.

Anyway, I don't want to bikeshed too much over this, I'm not going to actively prevent anybody from moving this to sage.asymptotic. Just don't expect me to review this ticket :-)

[dkrenn]

Branch: u/dkrenn/asy/move-doc

[dkrenn]

New commits:

286801f	move asymptotic expansion index to sage/asymptotic
8f72fda	add conf.py
a98af13	update links to asymptotic module

[dkrenn]

Commit: a98af13

[dkrenn]

comment:7

Replying to @jdemeyer:

Replying to @dkrenn:

• For this asymptotic expansion project we had to create a separate asymptotic_expansion_index.rst in src/doc/en/reference/rings, which seems a bit unnatural.

Why unnatural? We have a separate index in the manual about finite rings for example, but I don't think we should have sage.finite_rings.

Oh yes, I see; thanks for pointing this out. I will just do it as it is for the finite rings and only move the documentation.

[cheuberg]

Changed branch from u/dkrenn/asy/move-doc to u/cheuberg/asy/move-doc

[cheuberg]

Author: Daniel Krenn

[cheuberg]

comment:9

I added a commit related to documentation which was lost during work on #19399.

Apart from that: documentation builds and works as expected. Thus from my side, this is a positive review. I'll set this to positive review in a few days if there are no objections by anybody else.

---

New commits:

997380b	Trac #19399: Insert ReSt links
55ea3a9	Trac #19400: Merge commit '997380baa67cc3d7fda5e9791c29d58f3ff15515' from #19399

[cheuberg]

Reviewer: Clemens Heuberger

[cheuberg]

Changed commit from a98af13 to 55ea3a9

[vbraun]

Changed branch from u/cheuberg/asy/move-doc to 55ea3a9