[llvm-bugs] [Bug 47062] New: sphinx docs docs fail to compile with: "duplicate token description of SimpleValue, other instance in TableGen/LangRef"

[via llvm-bugs]

https://bugs.llvm.org/show_bug.cgi?id=47062

            Bug ID: 47062
           Summary: sphinx docs docs fail to compile with: "duplicate
                    token description of SimpleValue, other instance in
                    TableGen/LangRef"
           Product: Documentation
           Version: trunk
          Hardware: PC
                OS: Linux
            Status: NEW
          Severity: normal
          Priority: P
         Component: General docs
          Assignee: unassignedbugs at nondot.org
          Reporter: tmfinken at gmail.com
                CC: llvm-bugs at lists.llvm.org

The llvm  that sphinx documentation has some warnings, which are treated as
errors by default.

OS: Ubuntu 20.04..1
sphinx-build: 3.1.2
cmake: 3.16.3

##### By default, build will fail #####
$ mkdir build; cd build
$ cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true ../llvm/
...
$ make docs-llvm-html
...
/usr/local/lib/python3.8/dist-packages/recommonmark/parser.py:75: UserWarning:
Container node skipped: type=document
  warn("Container node skipped: type={0}".format(mdnode.t))
...
Warning, treated as error:
/llvm/docs/TableGen/LangRef.rst:270:duplicate token description of SimpleValue,
other instance in TableGen/LangRef


##### Set "SPHINX_WARNINGS_AS_ERRORS=false" to allow build to continue #####
$ mkdir build; cd build
$ cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true
-DSPHINX_WARNINGS_AS_ERRORS=false ../llvm/
$ make docs-llvm-html
/usr/local/lib/python3.8/dist-packages/recommonmark/parser.py:75: UserWarning:
Container node skipped: type=document
  warn("Container node skipped: type={0}".format(mdnode.t))
llvm/docs/TableGen/LangRef.rst:270: WARNING: duplicate token description of
SimpleValue, other instance in TableGen/LangRef
llvm/docs/TableGen/LangRef.rst:275: WARNING: duplicate token description of
SimpleValue, other instance in TableGen/LangRef
llvm/docs/TableGen/LangRef.rst:281: WARNING: duplicate token description of
SimpleValue, other instance in TableGen/LangRef
llvm/docs/TableGen/LangRef.rst:286: WARNING: duplicate token description of
SimpleValue, other instance in TableGen/LangRef
llvm/docs/TableGen/LangRef.rst:291: WARNING: duplicate token description of
SimpleValue, other instance in TableGen/LangRef
llvm/docs/TableGen/LangRef.rst:299: WARNING: duplicate token description of
SimpleValue, other instance in TableGen/LangRef
llvm/docs/TableGen/LangRef.rst:306: WARNING: duplicate token description of
SimpleValue, other instance in TableGen/LangRef
llvm/docs/TableGen/LangRef.rst:317: WARNING: duplicate token description of
SimpleValue, other instance in TableGen/LangRef
llvm/docs/TableGen/LangRef.rst:324: WARNING: duplicate token description of
SimpleValue, other instance in TableGen/LangRef

Snippet from "llvm/docs/TableGen/LangRef.rst":

===============================
.. productionlist::
SimpleValue: `TokInteger`

This represents the numeric value of the integer.

.. productionlist::
SimpleValue: `TokString`+

Multiple adjacent string literals are concatenated like in C/C++. The value
is the concatenation of the strings.
===============================

Possible related upstream Sphinx issue:
https://github.com/sphinx-doc/sphinx/issues/7427


At least as a short-term fix, SPHINX_WARNINGS_AS_ERRORS could default to false.

-- 
You are receiving this mail because:
You are on the CC list for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-bugs/attachments/20200809/2b325f95/attachment-0001.html>