Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
mkoeppe opened this issue May 6, 2020 · 65 comments
Closed

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

mkoeppe opened this issue May 6, 2020 · 65 comments

Comments

@mkoeppe
Copy link
Contributor

mkoeppe commented May 6, 2020

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

@mkoeppe mkoeppe added this to the sage-9.2 milestone May 6, 2020
@mkoeppe
Copy link
Contributor Author

mkoeppe commented May 28, 2020

Changed keywords from none to sd109

@mkoeppe
Copy link
Contributor Author

mkoeppe commented May 29, 2020

Dependencies: #29745

@mkoeppe mkoeppe modified the milestones: sage-9.2, sage-9.3 Oct 24, 2020
@mkoeppe
Copy link
Contributor Author

mkoeppe commented Dec 9, 2020

Changed keywords from sd109 to sd109, sd111

@mkoeppe

This comment has been minimized.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Dec 29, 2020

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

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

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

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

Commit: 7ad2d92

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

Changed commit from 7ad2d92 to 316a7d2

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

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

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

Changed commit from 316a7d2 to 546e15a

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

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

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

@mkoeppe

This comment has been minimized.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

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

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

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

Changed commit from 546e15a to e08928d

@mkoeppe

This comment has been minimized.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Dec 29, 2020

Author: Matthias Koeppe

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Dec 29, 2020

Changed dependencies from #29745 to #29745, #30955

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

Changed commit from e08928d to 5e61388

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

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'

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 30, 2020

Changed commit from 5e61388 to ba4ac57

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 30, 2020

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'

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 30, 2020

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'

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 30, 2020

Changed commit from ba4ac57 to 897d8bd

@dimpase
Copy link
Member

dimpase commented Jan 1, 2021

@dimpase
Copy link
Member

dimpase commented Jan 1, 2021

New commits:

54d4fb1extra line after version

@dimpase
Copy link
Member

dimpase commented Jan 1, 2021

Changed commit from 58c63e1 to 54d4fb1

@dimpase
Copy link
Member

dimpase commented Jan 1, 2021

comment:42

lgtm

@dimpase
Copy link
Member

dimpase commented Jan 1, 2021

Reviewer: Dima Pasechnik

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Jan 1, 2021

comment:43

Thanks!

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Jan 3, 2021

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Jan 3, 2021

New commits:

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

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Jan 3, 2021

Changed commit from 54d4fb1 to 3fe8d4c

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jan 4, 2021

Changed commit from 3fe8d4c to 49ad8ae

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jan 4, 2021

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

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

@dimpase
Copy link
Member

dimpase commented Jan 4, 2021

comment:48

OK, good

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Jan 5, 2021

comment:49

Thanks!

@vbraun
Copy link
Member

vbraun commented Jan 17, 2021

Changed branch from u/mkoeppe/improve_build_pkgs___spkg_rst to 49ad8ae

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants