Opened 2 years ago

Last modified 21 months ago

#29655 closed enhancement

Improve build/pkgs/*/SPKG.rst — at Version 31

Reported by: Matthias Köppe Owned by:
Priority: critical Milestone: sage-9.3
Component: documentation Keywords: sd109, sd111
Cc: John Palmieri, François Bissey, Frédéric Chapoton, Dima Pasechnik, Samuel Lelièvre, Luca De Feo, Sébastien Labbé Merged in:
Authors: Matthias Koeppe Reviewers:
Report Upstream: N/A Work issues:
Branch: u/mkoeppe/improve_build_pkgs___spkg_rst (Commits, GitHub, GitLab) Commit: 6463353ce33586ae9c7b19c3b5ffedd3767ae524
Dependencies: #29745, #30955 Stopgaps:

Status badges

Description (last modified by Matthias Köppe)

With #29633, we now generate a full list of packages that Sage uses (with links to documentation - see #27495) for the reference manual from information in build/pkgs/*/SPKG.rst (which used to be SPKG.txt).

The purpose of this ticket is to improve the SPKG.rst files.

  1. If other sources have better information than what is in build/pkgs, update build/pkgs accordingly. (See https://wiki.sagemath.org/SageWiki)
  1. Delete/archive the obsolete other sources.
  1. Change the titles of the SPKG.rst files to use the format "spkg_name: Short description". This will improve the table of contents shown in https://doc.sagemath.org/html/en/reference/spkg/index.html, which the Sage website is pointing to after https://github.com/sagemath/website/pull/212
  1. Extend build/bin/sage-spkg-info and use it to format additional information from build/pkgs/SPKG/.
  1. In addition to the full alphabetical list of packages, also show the standard packages, the optional packages, and the experimental packages separately.

Follow-up:

  • #31136 Rename SPKGs to match their PyPI name

Change History (31)

comment:1 Changed 2 years ago by Matthias Köppe

Keywords: sd109 added

comment:2 Changed 2 years ago by Matthias Köppe

Dependencies: #29745

comment:3 Changed 2 years ago by Matthias Köppe

Cc: Samuel Lelièvre added

comment:4 Changed 2 years ago by Matthias Köppe

Milestone: sage-9.2sage-9.3

comment:5 Changed 22 months ago by Matthias Köppe

Keywords: sd111 added

comment:6 Changed 22 months ago by Luca De Feo

Cc: Luca De Feo added

comment:7 Changed 22 months ago by Matthias Köppe

Description: modified (diff)

comment:8 Changed 22 months ago by Matthias Köppe

Branch: u/mkoeppe/improve_build_pkgs___spkg_rst

comment:9 Changed 21 months ago by git

Commit: 7ad2d926263af3301582ae6e6321a45d85e7d294

Branch pushed to git repo; I updated commit sha1. New commits:

7ad2d92build/pkgs/a*/SPKG.rst: Update from https://wiki.sagemath.org/spkg

comment:10 Changed 21 months ago by git

Commit: 7ad2d926263af3301582ae6e6321a45d85e7d294316a7d2fc44cb3f125defa9368a6df9adcbf3a16

Branch pushed to git repo; I updated commit sha1. New commits:

ea524aebuild/pkgs/beautifulsoup4/SPKG.rst: New, from pypi and https://wiki.sagemath.org/spkg
b6f40acbuild/pkgs/biopython/SPKG.rst: New, from pypi and https://wiki.sagemath.org/spkg
316a7d2build/pkgs/b*/SPKG.rst: Update from https://wiki.sagemath.org/spkg

comment:11 Changed 21 months ago by git

Commit: 316a7d2fc44cb3f125defa9368a6df9adcbf3a16546e15a16ec3501e4f92cf2e76d0248617cba107

Branch pushed to git repo; I updated commit sha1. New commits:

546e15abuild/pkgs/*/SPKG.rst: Update remaining packages from https://wiki.sagemath.org/spkg

comment:12 Changed 21 months ago by Matthias Köppe

Description: modified (diff)

comment:13 Changed 21 months ago by git

Commit: 546e15a16ec3501e4f92cf2e76d0248617cba107e08928d8ca5ff342cb24de4c53473394657f373a

Branch pushed to git repo; I updated commit sha1. New commits:

e08928dbuild/pkgs/[e-z]*/SPKG.rst: Update from website conf/packages.yaml

comment:14 Changed 21 months ago by Matthias Köppe

Description: modified (diff)

comment:15 Changed 21 months ago by Matthias Köppe

Authors: Matthias Koeppe
Status: newneeds_review

comment:16 Changed 21 months ago by Matthias Köppe

Dependencies: #29745#29745, #30955

comment:17 Changed 21 months ago by git

Commit: e08928d8ca5ff342cb24de4c53473394657f373a5e61388d6bf9bffc2f2cf426dcb1e5080de926dc

Branch pushed to git repo; I updated commit sha1. New commits:

23c4903src/doc/bootstrap: sort the SPKG list
b98bcbbfor f in build/pkgs/*/SPKG.txt; do pandoc --from=mediawiki --to=rst $f --output=$(dirname $f)/SPKG.rst; git rm -f $f; git add $(dirname $f)/SPKG.rst; done
047ffcbbuild/pkgs/*/SPKG.rst: Remove remaining changelogs
224059aFix up RST syntax
5fe3989Merge branch 't/30955/change_remaining_spkg_txt_to_spkg_rst' into t/29655/improve_build_pkgs___spkg_rst
5e61388build/pkgs/[0-b]*/SPKG.rst: Reformat title in format 'spkg_name: Short description'

comment:18 Changed 21 months ago by git

Commit: 5e61388d6bf9bffc2f2cf426dcb1e5080de926dcba4ac57dc0f16691f67b0c02ab1cad4cabf069a0

Branch pushed to git repo; I updated commit sha1. New commits:

ba4ac57build/pkgs/[b-c]*/SPKG.rst: Reformat title in format 'spkg_name: Short description'

comment:19 Changed 21 months ago by git

Commit: ba4ac57dc0f16691f67b0c02ab1cad4cabf069a0897d8bd243658c713697ad8c679c1b0d92ac67da

Branch pushed to git repo; I updated commit sha1. New commits:

897d8bdbuild/pkgs/[c-d]*/SPKG.rst: Reformat title in format 'spkg_name: Short description'

comment:20 Changed 21 months ago by git

Commit: 897d8bd243658c713697ad8c679c1b0d92ac67da3775de3015828064c13b5e101a9380757bd55161

Branch pushed to git repo; I updated commit sha1. New commits:

3775de3build/pkgs/[e-g]*/SPKG.rst: Reformat title in format 'spkg_name: Short description'

comment:21 Changed 21 months ago by git

Commit: 3775de3015828064c13b5e101a9380757bd55161a08dad26f811258b3013273604b14b65c731c6ee

Branch pushed to git repo; I updated commit sha1. New commits:

a08dad2build/pkgs/[h-m]*/SPKG.rst: Reformat title in format 'spkg_name: Short description'

comment:22 Changed 21 months ago by Matthias Köppe

Help with the remaining packages is certainly welcome

comment:23 Changed 21 months ago by Matthias Köppe

Description: modified (diff)

comment:24 Changed 21 months ago by Matthias Köppe

Description: modified (diff)

comment:25 Changed 21 months ago by Matthias Köppe

Cc: Sébastien Labbé added
Status: needs_reviewneeds_work

comment:26 Changed 21 months ago by Matthias Köppe

Description: modified (diff)

comment:27 Changed 21 months ago by git

Commit: a08dad26f811258b3013273604b14b65c731c6ee82b95c69616b5d63013302facccb5ba18a8065f5

Branch pushed to git repo; I updated commit sha1. New commits:

5a27857build/bin/sage-print-system-package-command: Add nix
4c1193dbuild/bin/sage-spkg: Remove redundant output, remove error message for 'sage -info' for non-normal packages
82b95c6build/bin/sage-spkg-info: Format more info, use RST style, use it in src/doc/bootstrap

comment:28 Changed 21 months ago by git

Commit: 82b95c69616b5d63013302facccb5ba18a8065f5b3b004180fc59e6be2361a4e806d280bdc019448

Branch pushed to git repo; I updated commit sha1. New commits:

b3b0041build/bin/sage-spkg-info: For Python packages, point to #29023, not #27330

comment:29 Changed 21 months ago by git

Commit: b3b004180fc59e6be2361a4e806d280bdc0194486463353ce33586ae9c7b19c3b5ffedd3767ae524

Branch pushed to git repo; I updated commit sha1. New commits:

c0ccb9fsrc/doc/bootstrap: Generate packages by type
6463353build/pkgs/[m-z]*/SPKG.rst: Reformat title in format 'spkg_name: Short description' -- for all remaining packages from packages.yaml

comment:30 Changed 21 months ago by Matthias Köppe

Status: needs_workneeds_review

comment:31 Changed 21 months ago by Matthias Köppe

Description: modified (diff)
Note: See TracTickets for help on using tickets.