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

Change remaining SPKG.txt to SPKG.rst, delete remaining SPKG changelogs #30955

Closed
mkoeppe opened this issue Nov 24, 2020 · 20 comments
Closed

Change remaining SPKG.txt to SPKG.rst, delete remaining SPKG changelogs #30955

mkoeppe opened this issue Nov 24, 2020 · 20 comments

Comments

@mkoeppe
Copy link
Contributor

mkoeppe commented Nov 24, 2020

Follow-up from #29633 and #29636.

CC: @jhpalmieri @seblabbe @Etn40ff

Component: documentation

Keywords: sd111

Author: Matthias Koeppe

Branch/Commit: 224059a

Reviewer: Sébastien Labbé, Frédéric Chapoton

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

@mkoeppe mkoeppe added this to the sage-9.3 milestone Nov 24, 2020
@mkoeppe
Copy link
Contributor Author

mkoeppe commented Nov 24, 2020

comment:1

In #29633, this was done using

for 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'

with some manual editing afterwards

@mkoeppe

This comment has been minimized.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Nov 24, 2020

@mkoeppe

This comment has been minimized.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Nov 25, 2020

New commits:

e2729b7for 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

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Nov 25, 2020

Commit: e2729b7

@mkoeppe mkoeppe changed the title Change remaining SPKG.txt to SPKG.rst Change remaining SPKG.txt to SPKG.rst, delete remaining SPKG changelogs Nov 25, 2020
@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Nov 25, 2020

Changed commit from e2729b7 to cf6d70d

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Nov 25, 2020

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

cf6d70dbuild/pkgs/*/SPKG.rst: Remove remaining changelogs

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Nov 25, 2020

Author: Matthias Koeppe

@seblabbe
Copy link
Contributor

Reviewer: Sébastien Labbé

@seblabbe
Copy link
Contributor

comment:6

Green bot on top of 9.3.beta2.

I think we should do the same with the README of sage which at some point in time was translated from rst syntax to markdown so that it looks nice on github.com (the good solution at the time was to rename the file README.txt to README.rst, but I arrived to late on the ticket).

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Nov 26, 2020

comment:7

Thanks!

@kiwifb
Copy link
Member

kiwifb commented Dec 8, 2020

comment:8

Cannot build the doc in sage-on-gentoo

[spkg     ] /dev/shm/portage/sci-mathematics/sage-9999/work/sage-9999/src-python3_8/doc/en/reference/spkg/pycparser.rst:18: WARNING: duplicate label upstream_contact, other instance in /dev/shm/portage/sci-mathematics/sage-9999/work/sage-9999/src-python3_8/doc/en/reference/spkg/libxml2.rst
[spkg     ] The inventory files are in ../../build_doc/inventory/en/reference/spkg.
Error building the documentation.
Traceback (most recent call last):
  File "sage_setup/docbuild/__main__.py", line 2, in <module>
    main()
  File "/dev/shm/portage/sci-mathematics/sage-9999/work/sage-9999/src-python3_8/sage_setup/docbuild/__init__.py", line 1730, in main
    builder()
  File "/dev/shm/portage/sci-mathematics/sage-9999/work/sage-9999/src-python3_8/sage_setup/docbuild/__init__.py", line 343, in _wrapper
    getattr(get_builder(document), 'inventory')(*args, **kwds)
  File "/dev/shm/portage/sci-mathematics/sage-9999/work/sage-9999/src-python3_8/sage_setup/docbuild/__init__.py", line 569, in _wrapper
    self._build_everything_except_bibliography(lang, format, *args, **kwds)
  File "/dev/shm/portage/sci-mathematics/sage-9999/work/sage-9999/src-python3_8/sage_setup/docbuild/__init__.py", line 555, in _build_everything_except_bibliography
    build_many(build_ref_doc, non_references)
  File "/dev/shm/portage/sci-mathematics/sage-9999/work/sage-9999/src-python3_8/sage_setup/docbuild/__init__.py", line 295, in build_many
    _build_many(target, args, processes=NUM_THREADS)
  File "/dev/shm/portage/sci-mathematics/sage-9999/work/sage-9999/src-python3_8/sage_setup/docbuild/utils.py", line 289, in build_many
    raise worker_exc.original_exception
OSError: /dev/shm/portage/sci-mathematics/sage-9999/work/sage-9999/src-python3_8/doc/en/reference/spkg/libnauty.rst:33: WARNING: duplicate label upstream_contact, other instance in /dev/shm/portage/sci-mathematics/sage-9999/work/sage-9999/src-python3_8/doc/en/reference/spkg/cffi.rst

There are multiple instances of upstream_contact being Upstream Contact and that seem to throw sphinx off, at least here.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Dec 10, 2020

Changed keywords from none to sd111

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

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

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Dec 29, 2020

Changed commit from cf6d70d to 224059a

@fchapoton
Copy link
Contributor

Changed reviewer from Sébastien Labbé to Sébastien Labbé, Frédéric Chapoton

@fchapoton
Copy link
Contributor

comment:14

ok, let us try again

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Jan 1, 2021

comment:15

Thanks.

@vbraun
Copy link
Member

vbraun commented Jan 4, 2021

Changed branch from u/mkoeppe/change_remaining_spkg_txt_to_spkg_rst to 224059a

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

5 participants