Opened 3 months ago
Closed 2 months ago
#30955 closed enhancement (fixed)
Change remaining SPKG.txt to SPKG.rst, delete remaining SPKG changelogs
Reported by:  mkoeppe  Owned by:  

Priority:  minor  Milestone:  sage9.3 
Component:  documentation  Keywords:  sd111 
Cc:  jhpalmieri, slabbe, etn40ff  Merged in:  
Authors:  Matthias Koeppe  Reviewers:  Sébastien Labbé, Frédéric Chapoton 
Report Upstream:  N/A  Work issues:  
Branch:  224059a (Commits, GitHub, GitLab)  Commit:  224059a833b2457e4d74d59994fc8599dd67fa16 
Dependencies:  Stopgaps: 
Description (last modified by )
Change History (16)
comment:1 Changed 3 months ago by
 Cc slabbe added
 Description modified (diff)
comment:2 Changed 3 months ago by
 Branch set to u/mkoeppe/change_remaining_spkg_txt_to_spkg_rst
comment:3 Changed 3 months ago by
 Commit set to e2729b76a63e494a157d08b04be05a31fa8b5979
 Description modified (diff)
 Summary changed from Change remaining SPKG.txt to SPKG.rst to Change remaining SPKG.txt to SPKG.rst, delete remaining SPKG changelogs
New commits:
e2729b7  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

comment:4 Changed 3 months ago by
 Commit changed from e2729b76a63e494a157d08b04be05a31fa8b5979 to cf6d70df94f0a2b47f8b43c57d5983b2eac46b51
Branch pushed to git repo; I updated commit sha1. New commits:
cf6d70d  build/pkgs/*/SPKG.rst: Remove remaining changelogs

comment:5 Changed 3 months ago by
 Status changed from new to needs_review
comment:6 Changed 3 months ago by
 Reviewers set to Sébastien Labbé
 Status changed from needs_review to positive_review
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).
comment:7 Changed 3 months ago by
Thanks!
comment:8 Changed 3 months ago by
Cannot build the doc in sageongentoo
[spkg ] /dev/shm/portage/scimathematics/sage9999/work/sage9999/srcpython3_8/doc/en/reference/spkg/pycparser.rst:18: WARNING: duplicate label upstream_contact, other instance in /dev/shm/portage/scimathematics/sage9999/work/sage9999/srcpython3_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/scimathematics/sage9999/work/sage9999/srcpython3_8/sage_setup/docbuild/__init__.py", line 1730, in main builder() File "/dev/shm/portage/scimathematics/sage9999/work/sage9999/srcpython3_8/sage_setup/docbuild/__init__.py", line 343, in _wrapper getattr(get_builder(document), 'inventory')(*args, **kwds) File "/dev/shm/portage/scimathematics/sage9999/work/sage9999/srcpython3_8/sage_setup/docbuild/__init__.py", line 569, in _wrapper self._build_everything_except_bibliography(lang, format, *args, **kwds) File "/dev/shm/portage/scimathematics/sage9999/work/sage9999/srcpython3_8/sage_setup/docbuild/__init__.py", line 555, in _build_everything_except_bibliography build_many(build_ref_doc, non_references) File "/dev/shm/portage/scimathematics/sage9999/work/sage9999/srcpython3_8/sage_setup/docbuild/__init__.py", line 295, in build_many _build_many(target, args, processes=NUM_THREADS) File "/dev/shm/portage/scimathematics/sage9999/work/sage9999/srcpython3_8/sage_setup/docbuild/utils.py", line 289, in build_many raise worker_exc.original_exception OSError: /dev/shm/portage/scimathematics/sage9999/work/sage9999/srcpython3_8/doc/en/reference/spkg/libnauty.rst:33: WARNING: duplicate label upstream_contact, other instance in /dev/shm/portage/scimathematics/sage9999/work/sage9999/srcpython3_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.
comment:9 Changed 3 months ago by
 Status changed from positive_review to needs_work
comment:10 Changed 3 months ago by
 Cc etn40ff added
comment:11 Changed 3 months ago by
 Keywords sd111 added
comment:12 Changed 2 months ago by
 Commit changed from cf6d70df94f0a2b47f8b43c57d5983b2eac46b51 to 224059a833b2457e4d74d59994fc8599dd67fa16
Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:
b98bcbb  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

047ffcb  build/pkgs/*/SPKG.rst: Remove remaining changelogs

224059a  Fix up RST syntax

comment:13 Changed 2 months ago by
 Status changed from needs_work to needs_review
comment:14 Changed 2 months ago by
 Reviewers changed from Sébastien Labbé to Sébastien Labbé, Frédéric Chapoton
 Status changed from needs_review to positive_review
ok, let us try again
comment:15 Changed 2 months ago by
Thanks.
comment:16 Changed 2 months ago by
 Branch changed from u/mkoeppe/change_remaining_spkg_txt_to_spkg_rst to 224059a833b2457e4d74d59994fc8599dd67fa16
 Resolution set to fixed
 Status changed from positive_review to closed
In #29633, this was done using
with some manual editing afterwards