Skip to content

Improve build/pkgs/*/SPKG.rst #29655

@mkoeppe

Description

@mkoeppe

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 and the scripts that transform them to generate a part of the Sage reference manual.

  1. If other sources have better information than what is in build/pkgs, update build/pkgs accordingly. (See https://wiki.sagemath.org/SageWiki)

  2. Delete/archive the obsolete other sources.

  3. 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 Replace components by link to spkg section in the reference manual website#212

  4. Extend build/bin/sage-spkg-info and use it to format additional information from build/pkgs/SPKG/.

  5. In addition to the full alphabetical list of packages, also show the standard packages, the optional packages, and the experimental packages separately.

Follow-up:

Depends on #29745
Depends on #30955

CC: @jhpalmieri @kiwifb @fchapoton @dimpase @slel @defeo @seblabbe

Component: documentation

Keywords: sd109, sd111

Author: Matthias Koeppe

Branch/Commit: 49ad8ae

Reviewer: Dima Pasechnik

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions