[PATCH] D91117: [Flang][Docs] Fix warnings when building docs.

[sameeran joshi via Phabricator via llvm-commits]

sameeranjoshi created this revision.
sameeranjoshi added reviewers: jdoerfert, sscalpone, kiranktp.
Herald added a subscriber: arphaman.
Herald added a project: LLVM.
sameeranjoshi requested review of this revision.

Following warning were seen with recommonmark(0.5.0) and sphinx(1.8.5).
`parser.py:75: UserWarning: Container node skipped: type=document warn("Container node skipped: type={0}".format(mdnode.t))`

The warnings are due to an issue in recommonmark's(a python package) older versions.
A better solution is to use the latest version of recommonmark(>=0.6.0) to avoid
these issue in the first place.
This patch fixes the warnings for older versions.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D91117

Files:
  flang/docs/conf.py
  flang/docs/index.md


Index: flang/docs/index.md
===================================================================
--- flang/docs/index.md
+++ flang/docs/index.md
@@ -47,6 +47,7 @@
    OptionComparison
    ParserCombinators
    RuntimeDescriptor
+   RuntimeTypeInfo
    Calls
    Character
    ArrayComposition
Index: flang/docs/conf.py
===================================================================
--- flang/docs/conf.py
+++ flang/docs/conf.py
@@ -11,6 +11,7 @@
 
 import sys, os
 from datetime import date
+from recommonmark.parser import CommonMarkParser
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -19,6 +20,13 @@
 
 # -- General configuration -----------------------------------------------------
 
+# https://github.com/readthedocs/recommonmark/issues/177
+#Method used to remove the warning message.
+class CustomCommonMarkParser(CommonMarkParser):
+    def visit_document(self, node):
+        pass
+
+
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 # Add any Sphinx extension module names here, as strings. They can be extensions
@@ -44,7 +52,7 @@
     # This requires 0.5 or later.
     extensions.append('recommonmark')
   else:
-    source_parsers = {'.md': 'recommonmark.parser.CommonMarkParser'}
+    source_parsers = {'.md': CustomCommonMarkParser}
   source_suffix['.md'] = 'markdown'
   extensions.append('sphinx_markdown_tables')
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D91117.304036.patch
Type: text/x-patch
Size: 1506 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20201110/28a23723/attachment.bin>