Opened 9 months ago

Closed 5 days ago

#29655 closed enhancement (fixed)

Improve build/pkgs/*/SPKG.rst

Reported by: mkoeppe Owned by:
Priority: critical Milestone: sage-9.3
Component: documentation Keywords: sd109, sd111
Cc: jhpalmieri, fbissey, chapoton, dimpase, slelievre, defeo, slabbe Merged in:
Authors: Matthias Koeppe Reviewers: Dima Pasechnik
Report Upstream: N/A Work issues:
Branch: 49ad8ae (Commits) Commit: 49ad8ae6ee9abc11ff2eec5d9b30df2878abe27a
Dependencies: #29745, #30955 Stopgaps:

Description (last modified by 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)
  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 (50)

comment:1 Changed 8 months ago by mkoeppe

  • Keywords sd109 added

comment:2 Changed 8 months ago by mkoeppe

  • Dependencies set to #29745

comment:3 Changed 6 months ago by mkoeppe

  • Cc slelievre added

comment:4 Changed 3 months ago by mkoeppe

  • Milestone changed from sage-9.2 to sage-9.3

comment:5 Changed 6 weeks ago by mkoeppe

  • Keywords sd111 added

comment:6 Changed 6 weeks ago by defeo

  • Cc defeo added

comment:7 Changed 4 weeks ago by mkoeppe

  • Description modified (diff)

comment:8 Changed 4 weeks ago by mkoeppe

  • Branch set to u/mkoeppe/improve_build_pkgs___spkg_rst

comment:9 Changed 4 weeks ago by git

  • Commit set to 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 4 weeks ago by git

  • Commit changed from 7ad2d926263af3301582ae6e6321a45d85e7d294 to 316a7d2fc44cb3f125defa9368a6df9adcbf3a16

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 4 weeks ago by git

  • Commit changed from 316a7d2fc44cb3f125defa9368a6df9adcbf3a16 to 546e15a16ec3501e4f92cf2e76d0248617cba107

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 4 weeks ago by mkoeppe

  • Description modified (diff)

comment:13 Changed 4 weeks ago by git

  • Commit changed from 546e15a16ec3501e4f92cf2e76d0248617cba107 to e08928d8ca5ff342cb24de4c53473394657f373a

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 4 weeks ago by mkoeppe

  • Description modified (diff)

comment:15 Changed 4 weeks ago by mkoeppe

  • Authors set to Matthias Koeppe
  • Status changed from new to needs_review

comment:16 Changed 3 weeks ago by mkoeppe

  • Dependencies changed from #29745 to #29745, #30955

comment:17 Changed 3 weeks ago by git

  • Commit changed from e08928d8ca5ff342cb24de4c53473394657f373a to 5e61388d6bf9bffc2f2cf426dcb1e5080de926dc

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 3 weeks ago by git

  • Commit changed from 5e61388d6bf9bffc2f2cf426dcb1e5080de926dc to ba4ac57dc0f16691f67b0c02ab1cad4cabf069a0

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 3 weeks ago by git

  • Commit changed from ba4ac57dc0f16691f67b0c02ab1cad4cabf069a0 to 897d8bd243658c713697ad8c679c1b0d92ac67da

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 3 weeks ago by git

  • Commit changed from 897d8bd243658c713697ad8c679c1b0d92ac67da to 3775de3015828064c13b5e101a9380757bd55161

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 3 weeks ago by git

  • Commit changed from 3775de3015828064c13b5e101a9380757bd55161 to a08dad26f811258b3013273604b14b65c731c6ee

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 3 weeks ago by mkoeppe

Help with the remaining packages is certainly welcome

comment:23 Changed 3 weeks ago by mkoeppe

  • Description modified (diff)

comment:24 Changed 3 weeks ago by mkoeppe

  • Description modified (diff)

comment:25 Changed 3 weeks ago by mkoeppe

  • Cc slabbe added
  • Status changed from needs_review to needs_work

comment:26 Changed 3 weeks ago by mkoeppe

  • Description modified (diff)

comment:27 Changed 3 weeks ago by git

  • Commit changed from a08dad26f811258b3013273604b14b65c731c6ee to 82b95c69616b5d63013302facccb5ba18a8065f5

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 3 weeks ago by git

  • Commit changed from 82b95c69616b5d63013302facccb5ba18a8065f5 to b3b004180fc59e6be2361a4e806d280bdc019448

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 3 weeks ago by git

  • Commit changed from b3b004180fc59e6be2361a4e806d280bdc019448 to 6463353ce33586ae9c7b19c3b5ffedd3767ae524

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 3 weeks ago by mkoeppe

  • Status changed from needs_work to needs_review

comment:31 Changed 3 weeks ago by mkoeppe

  • Description modified (diff)

comment:32 Changed 3 weeks ago by mkoeppe

  • Priority changed from major to critical

comment:33 Changed 3 weeks ago by git

  • Commit changed from 6463353ce33586ae9c7b19c3b5ffedd3767ae524 to 6f3b86433f7d3d8b2bcc11c27ed802b420355663

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

f5ac0e0build/pkgs/[n-s]*/SPKG.rst: Reformat title in format 'spkg_name: Short description'
109b3c2sage --package create --pypi: Adjust to new format of the SPKG.rst title
368c282build/pkgs/setuptools_scm/SPKG.rst: Reformat title in format 'spkg_name: Short description'
6f3b864build/pkgs/[s-t]*/SPKG.rst: Reformat title in format 'spkg_name: Short description'

comment:34 Changed 3 weeks ago by mkoeppe

  • Description modified (diff)

comment:35 Changed 3 weeks ago by git

  • Commit changed from 6f3b86433f7d3d8b2bcc11c27ed802b420355663 to 23558f8ef6dda94942f988f59420b93e72869e66

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

23558f8build/pkgs/[t-z]*/SPKG.rst: Reformat title in format 'spkg_name: Short description' -- completes coverage of all standard packages

comment:36 Changed 3 weeks ago by git

  • Commit changed from 23558f8ef6dda94942f988f59420b93e72869e66 to 17789df836a24dd8d9d69320b955ff6382bf575b

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

17789dfbuild/pkgs/[z-z]*/SPKG.rst: Reformat title in format 'spkg_name: Short description' -- completes coverage of all optional packages

comment:37 Changed 3 weeks ago by git

  • Commit changed from 17789df836a24dd8d9d69320b955ff6382bf575b to 944408d71cdb29af41319bc1aa251f215cc97aef

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

944408dbuild/pkgs/[a-z]*/SPKG.rst: Reformat title in format 'spkg_name: Short description' -- completes coverage of all experimental packages

comment:38 Changed 3 weeks ago by mkoeppe

Completed. Ready for review. ./bootstrap && make doc-html will build a much improved local/share/doc/sage/html/en/reference/spkg/index.html

comment:39 Changed 3 weeks ago by git

  • Commit changed from 944408d71cdb29af41319bc1aa251f215cc97aef to 58c63e151a4e8523e2724f1af61ad041cf98d2c8

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

feafa60src/doc/en/installation/standard_packages.rst: Remove
58c63e1src/doc/bootstrap: Add brief explanation of the standard/optional/experimental package types

comment:40 Changed 3 weeks ago by dimpase

  • Status changed from needs_review to needs_work
[dochtml] OSError: /mnt/opt/Sage/sage-dev/src/doc/en/reference/spkg/benzene.rst:47: WARNING: Literal block ends without a blank line; unexpected unindent.

indeed, in this generated file one sees

...
Version Information
-------------------

package-version.txt::

    20130630
Equivalent System Packages
--------------------------

...

comment:41 Changed 3 weeks ago by dimpase

  • Branch changed from u/mkoeppe/improve_build_pkgs___spkg_rst to u/dimpase/improve_build_pkgs___spkg_rst
  • Commit changed from 58c63e151a4e8523e2724f1af61ad041cf98d2c8 to 54d4fb18a83bfb2fdfec3d3483cae1e6383582c2
  • Status changed from needs_work to needs_review

New commits:

54d4fb1extra line after version

comment:42 Changed 3 weeks ago by dimpase

  • Reviewers set to Dima Pasechnik
  • Status changed from needs_review to positive_review

lgtm

comment:43 Changed 3 weeks ago by mkoeppe

Thanks!

comment:44 Changed 3 weeks ago by mkoeppe

  • Branch changed from u/dimpase/improve_build_pkgs___spkg_rst to u/mkoeppe/improve_build_pkgs___spkg_rst

comment:45 Changed 3 weeks ago by mkoeppe

  • Commit changed from 54d4fb18a83bfb2fdfec3d3483cae1e6383582c2 to 3fe8d4c458439c1a6d1a94a9ffefbbd76ef81962
  • Status changed from positive_review to needs_work

New commits:

2eac7a1src/doc/bootstrap: Use sage-spkg-info directly instead of 'sage --info', much faster now
3fe8d4csrc/sage/tests/cmdline.py: Adjust doctests

comment:46 Changed 3 weeks ago by mkoeppe

  • Status changed from needs_work to needs_review

comment:47 Changed 3 weeks ago by git

  • Commit changed from 3fe8d4c458439c1a6d1a94a9ffefbbd76ef81962 to 49ad8ae6ee9abc11ff2eec5d9b30df2878abe27a

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

49ad8aesrc/sage/tests/cmdline.py: Adjust doctest properly

comment:48 Changed 3 weeks ago by dimpase

  • Status changed from needs_review to positive_review

OK, good

comment:49 Changed 3 weeks ago by mkoeppe

Thanks!

comment:50 Changed 5 days ago by vbraun

  • Branch changed from u/mkoeppe/improve_build_pkgs___spkg_rst to 49ad8ae6ee9abc11ff2eec5d9b30df2878abe27a
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.