classification
Title: Automate update of doc references to UCD version when it changes.
Type: enhancement Stage: needs patch
Components: Versions: Python 3.5
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: BTaskaya, r.david.murray
Priority: normal Keywords: easy

Created on 2014-10-10 01:11 by r.david.murray, last changed 2019-11-18 22:33 by BTaskaya.

Messages (2)
msg228935 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-10-10 01:11
As noted by Alexander in issue 18176, we often forget to update the UCD references in the docs when we switch to a new version.  That issue added notes to the makeunicodedata script to list the places that need to be changed; however, it would be even better if makeunicodedata could somehow do the update automatically.

One possible way to do this easily might be to leverage sphinx 'substitutions' (I couldn't make that work in a short experiment, so it might not be feasible).  If not, it should be simple enough to write something to automate the editing of the lines in the rst files (probably using a hardcoded list of locations, but possibly by grepping for the URL pattern).

Alexander also discussed the possibility of auto-generating tables to insert into the documentation, in the context of the PropList.txt file.  I don't know if this is practical or desirable.
msg356923 - (view) Author: Batuhan (BTaskaya) * Date: 2019-11-18 22:33
I want to work on this. What do you think about using include directive and include a static file like UCD_VERSION.txt in the documents?

makeunicodedata.py can write the current version every run to UCD_VERSION.txt
History
Date User Action Args
2019-11-18 22:33:46BTaskayasetnosy: + BTaskaya
messages: + msg356923
2014-10-10 01:11:38r.david.murraycreate