[
https://issues.apache.org/jira/browse/TS-5107?focusedWorklogId=34509&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-34509
]
ASF GitHub Bot logged work on TS-5107:
--------------------------------------
Author: ASF GitHub Bot
Created on: 03/Jan/17 13:42
Start Date: 03/Jan/17 13:42
Worklog Time Spent: 10m
Work Description: 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 <deb...@jbfavre.org>
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`.
----
Issue Time Tracking
-------------------
Worklog Id: (was: 34509)
Time Spent: 10m
Remaining Estimate: 0h
> ATS 7.0.0 doesn't build against python docutils 0.13.1
> ------------------------------------------------------
>
> Key: TS-5107
> URL: https://issues.apache.org/jira/browse/TS-5107
> Project: Traffic Server
> Issue Type: Bug
> Components: Documentation
> Reporter: Jean Baptiste Favre
> Time Spent: 10m
> Remaining Estimate: 0h
>
> Trying to build ATS 7.0.0 with python docutils 0.13.1 on Debian fails
> with following error:
> {code}Making all in doc
> make[2]: Entering directory '/home/debocker/source/build/doc'
> PAPEROPT_a4="-D latex_paper_size=a4" PAPEROPT_letter="-D
> latex_paper_size=letter" PAPER="letter" ./sbuild sphinx-build -c . -d
> docbuild/doctrees -b man . docbuild/man
> Running Sphinx v1.4.9
> making output directory...
> WARNING: sphinx.ext.pngmath has been deprecated. Please use
> sphinx.ext.imgmath instead.
> loading pickled environment... not yet created
> building [mo]: targets for 0 po files that are out of date
> building [man]: all manpages
> updating environment: 456 added, 0 changed, 0 removed
> reading sources... [ 0%] admin-guide/configuration/cache-basics.en
> Exception occurred:
> File "conf.py", line 185, in __init__
> start_string_prefix=self.start_string_prefix,
> AttributeError: Inliner instance has no attribute 'start_string_prefix'
> The full traceback has been saved in /tmp/sphinx-err-5iq_t9.log, if you
> want to report the issue to the developers.
> Please also report this if it was a user error, so that a better error
> message can be provided next time.
> A bug report can be filed in the tracker at
> <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
> Makefile:998: recipe for target 'man' failed
> make[2]: Leaving directory '/home/debocker/source/build/doc'
> make[2]: *** [man] Error 1
> make[1]: *** [all-recursive] Error 1{code}
> I tracked it down to
> [docutils/parsers/rst/states.py|https://fossies.org/diffs/docutils/0.12_vs_0.13.1/docutils/parsers/rst/states.py-diff.html]
> which changed
> between 0.12 & 0.13.1
> {{start_string_prefix}} is not defined anymore at {{Inliner}} init. We have to
> call {{init_cutomizations}} method, but I can't figure out the {{settings}}
> structure.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
