[
https://issues.apache.org/jira/browse/COUCHDB-3068?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15389891#comment-15389891
]
ASF GitHub Bot commented on COUCHDB-3068:
-----------------------------------------
GitHub user katsel opened a pull request:
https://github.com/apache/couchdb-documentation/pull/53
COUCHDB-3068 - Fixes to make docs build with Sphinx 1.4
* Remove JSON as default highlight language from conf.py, so Sphinx does
not assume all non-marked code blocks are JSON per default.
* Use valid HTTP
* add ` HTTP/1.1` to each request line
* Pygments' http lexer currently does not recognize the COPY method, so
disable highlighting for blocks that use COPY.
* Minor changes with shell code-blocks - shell-sessions and shell-scripts
require different lexers.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/katsel/couchdb-documentation 3068-sphinx-1-4
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/couchdb-documentation/pull/53.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 #53
----
commit c94c04e84b72dcbba88ee6299d26884c012f4213
Author: katsel <[email protected]>
Date: 2016-07-22T17:20:38Z
COUCHDB-3068 - Fixes to make docs build with Sphinx 1.4
* remove JSON as default highlight language from config
* use valid HTTP
* minor changes with shell code-blocks
----
> Docs fail to build with Sphinx 1.4+
> -----------------------------------
>
> Key: COUCHDB-3068
> URL: https://issues.apache.org/jira/browse/COUCHDB-3068
> Project: CouchDB
> Issue Type: Bug
> Components: Documentation
> Reporter: Joan Touzet
> Assignee: Alexander Shorin
> Priority: Critical
> Labels: docs
> Fix For: 2.0.0
>
>
> After updating my local install of Sphinx to 1.4, I get the following error
> in the build:
> {noformat}
> looking for now-outdated files... none found
> pickling environment... done
> checking consistency... done
> preparing documents... done
> writing output... [ 0%] about
> writing output... [ 1%] api/basics
> Warning, treated as error:
> /home/joant/couchdb/src/docs/src/api/basics.rst:144: WARNING: Could not lex
> literal_block as "http". Highlighting skipped.
> {noformat}
> Because we specify {{-W}} on the {{sphinx-build}} line, we treat all warnings
> as errors the build stops here. Removing the -W allows the build to complete
> but results in 255 warnings where highlighting is being skipped as a result
> of a failure to parse the block. The full output of {{make html}} is here:
> https://paste.apache.org/DKOL
> The temporary fix is to disable the -W option in the makefile. [~janl]
> [~andywenk] this is something you might want to think about for the RC2
> release, though I suspect your local Sphinx is old enough that it's not
> running into the bug.
> The right fix is to fix the code blocks so they work under Sphinx 1.4+. See
> for instance [this diff|http://dpdk.org/dev/patchwork/patch/14861/] of how
> another project fixed their warnings - it's mainly un-escaping some text
> since the parser expects no syntax errors in the block of text.
> If no one else steps up by mid- next week I can look at this bug, but my time
> is booked until July 27th at the earliest.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
