GitHub user jbfavre opened a pull request:
https://github.com/apache/trafficserver/pull/1296
TS-5107: Fix documentation for docutils >= 0.13
Change introduced in docutils 0.13.0 breaks current documentation build.
Current doc build uses docutils Inliner monkey patching which is likely to
break with each docutils internal changes.
Therefore, I removed the Inliner monkey patching, introduced classic
docutils roles
definition using traffic_server extension.
I also updated the documentation using the new rst syntax introduced by the
role.
To declare an issue in the documentation one must now use folowing syntax:
`:tsissue:\`XXXX\`` where XXXX is the Jira's issue number.
Jira's base url is defined in `doc/conf.py` in variable
`trafficserver_issue_url`.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/jbfavre/trafficserver
fix_doc_for_docutils_0.13.1
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/trafficserver/pull/1296.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1296
----
commit df24cdb43f9cfb69bc8208f1ba80d01c27bc0b9f
Author: Jean Baptiste Favre <[email protected]>
Date: 2017-01-03T13:32:09Z
TS-5107: Fix documentation for docutils >= 0.13
Change introduced in docutils 0.13.0 breaks current documentation build.
Current doc build uses docutils Inliner monkey patching which is likely to
break with each docutils internal changes.
Therefore, I removed the Inliner monkey patching, introduced classic
docutils roles
definition using traffic_server extension.
I also updated the documentation using the new rst syntax introduced by the
role.
To declare an issue in the documentation one must now use folowing syntax:
`:tsissue:\`XXXX\`` where XXXX is the Jira's issue number.
Jira's base url is defined in `doc/conf.py` in variable
`trafficserver_issue_url`.
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
