[Bug 31657] New: [DOCS] [Omnibus] Fix the cause of duplicate label warning messages when generating the manual
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 Bug ID: 31657 Summary: [DOCS] [Omnibus] Fix the cause of duplicate label warning messages when generating the manual Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: normal Priority: P5 - low Component: Documentation Assignee: koha-bugs@lists.koha-community.org Reporter: david@davidnind.com QA Contact: testopia@bugs.koha-community.org When generating the HTML version of the manual, there are a lot of duplicate label warning messages. This makes identifying and addressing other warning messages more of a challenge. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |david@davidnind.com |ity.org | --- Comment #1 from David Nind <david@davidnind.com> --- This issue was raised on the GitLab issues queue: https://gitlab.com/koha-community/koha-manual/-/issues/18 Caroline Cyr La Rose has identified the cause of the issue[1] and a solution: - Caused by: 'sphinx.ext.autosectionlabel' setting in conf.py - Proposed solution: . update conf.py to remove setting: 'sphinx.ext.autosectionlabel', . change references to system preferences from: :ref:`SystemPreferenceName` . to: :ref:`SystemPreferenceName <systempreferencename-label>` [1] https://www.spinics.net/lists/linux-doc/msg77015.html -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 --- Comment #2 from David Nind <david@davidnind.com> --- My suggested plan is to update these progressively - maybe a manual section/chapter at a time - as there are a lot of these to update! For each chapter/section being worked on, create a separate bug and link back in 'Depends on' to this omnibus bug - unless anyone else has a better idea. By the time it is finished this should have reduced the warning messages considerably - for me working locally, there currently there are 282 warning messages when the HTML output is produced. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |caroline.cyr-la-rose@inlibr | |o.com, david@davidnind.com --- Comment #3 from David Nind <david@davidnind.com> --- Caroline, I've added you to the bug. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |31658 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31658 [Bug 31658] Update conf.py to remove sphinx.ext.autosectionlabel -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 --- Comment #4 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- I am working on patches for this, hope to have something to show soon. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 --- Comment #5 from David Nind <david@davidnind.com> --- Thanks Katrin! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 --- Comment #6 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- First patch up: https://gitlab.com/koha-community/koha-manual/-/merge_requests/591 It did seem to work ok when I created the html files locally. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|david@davidnind.com |katrin.fischer@bsz-bw.de QA Contact|testopia@bugs.koha-communit |david@davidnind.com |y.org | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 --- Comment #7 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- A note to remember that we'll have to change the rst syntax cheatsheet on the wiki -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 --- Comment #8 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- I believe between Caroline's and my merge requests we should have taken care of all of them now. I suggest we remove the autosectionlabel after these are merged and then fix anything that remains. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 --- Comment #9 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- (In reply to Caroline Cyr La Rose from comment #7)
A note to remember that we'll have to change the rst syntax cheatsheet on the wiki
This is done -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |RESOLVED Documentation| |Merge requests 591 and 593 submission| | Resolution|--- |FIXED Documentation| |Katrin Fischer + Caroline contact| |Cyr La Rose --- Comment #10 from David Nind <david@davidnind.com> --- Woot! Thanks Katrin and Caroline for all your speedy work on updating all the refs and fixing the casue of error messages! The manual is now generated without any warning or other error messages! David -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31657 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Summary|[DOCS] [Omnibus] Fix the |[DOCS] Fix the cause of |cause of duplicate label |duplicate label warning |warning messages when |messages when generating |generating the manual |the manual -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon@bugs.koha-community.org