Hello, I've updated my PR on github. We can now manage both Jira issues with ":ts:jira:`XXXX`" syntax, as well as github issues with ":ts:github:`XXXX`" syntax.
Now, Trafficserver build succeed with doctuils 0.13.1. Please note that I did not test yet build against docutils 0.12. I'll in the coming days (docutils 0.12 is in Debian stable only). Cheers, Jean Baptiste On 03/01/2017 15:11, Jean Baptiste Favre wrote: > Hello Alan, > Thanks for the info. > I had a look in traffic_server.py, but to quick to notice about :ts:cv: :-/ > > given the Jira to Github transition announced by Brian at the end of > decembre, I only suggest we use :ts:issue:, more generic, instead on > :ts:jira: > > I'll update my pull request accordingly. > > Cheers, > Jean Baptiste Favre > > On 03/01/2017 15:07, Alan Carroll wrote: >> Please take a look at doc/ext/traffic-server.py (which I would think you've >> done, if you did this patch). There are already :ts: roles defined (e.g. >> :ts:cv: for configuration variables). Something like :ts:jira:`3612` might >> be a good choice. I think the goal of this patch was so that normal usage of >> "TS-3612" would get converted to a JIRA link, which may be a step too far. >> >> On Tuesday, January 3, 2017 4:32 AM, Jean Baptiste Favre >> <webmas...@jbfavre.org> wrote: >> >> >> Hello, >> I've had a discussion on docutils mailing list about this issue. >> >> Short story: we currently use docutils Inliner monkey patching which is >> likely to break things whenever docutils changes its API. >> This change happenned in 0.13.0 >> >> A more stable way of building ATS doc would be to use classic docutils >> roles, ie writing TS issues like ":TS: XXXX" instead of "(TS-XXXX)"and >> define a custom role which is supported, whereas our current way of >> monkey patching docutils Inliner isn't. >> >> I managed to build trafficserver against docutils 0.13.1, but this >> require a patch for both trafficserver & docutils. >> Discussion is still ongoing to know wether the new behaviour is buggy or >> not, and wether docutils patch should be included in next release or not. >> >> In the mean time, I'll work on implementing the docutils custom role. >> I'll open a github PR as soon as the doc refacto is completed. >> >> Trafficserver is about to be removed from Debian within 2 weeks (stable >> freeze is coming and Trafficserver build currently fails because of the >> doc) and I'm not sure docutils will be updated until then. >> >> Cheers, >> Jean Baptiste >> >>> The exception I get comes from code introduced 2 years and half ago >>> (commit 8ec35f2c7). >>> >>> Python docutils 0.13.1, which entrered Debian unstable on 2016-12-11, >>> breaks this piece of code. >>> >>> Trafficserver entered Debian unstable on 2016-11-29, which means build >>> was OK. >>> >>> I can't find any commit modifying doc/conf.py since the one you >>> mentionned which fix anything. >>> >>> Cheers, >>> Jean Baptiste Favre >
