[PATCH] D87242: [flang] Add new documentation main page

Tue Sep 15 11:09:35 PDT 2020

hans added a comment.

Sadly after this commit, I'm no longer able to build the Flang docs, my build failing like this:

  cd /work/llvm.monorepo/build.docs/tools/flang/docs && /usr/bin/sphinx-build -b html -d /work/llvm.monorepo/build.docs/tools/flang/docs/_doctrees-flang-html -q -t builder-html /work/llvm.mo
  norepo/flang/docs /work/llvm.monorepo/build.docs/tools/flang/docs/html                                                                                                                      
  /usr/lib/python3/dist-packages/sphinx/util/compat.py:30: RemovedInSphinx30Warning: The config variable "source_parsers" is deprecated. Please update your extension for the parser and remov
  e the setting.                                                                                                                                                                              
    warnings.warn('The config variable "source_parsers" is deprecated. '                                                                                                                      
  /usr/lib/python3/dist-packages/sphinx/util/compat.py:36: RemovedInSphinx30Warning: app.add_source_parser() does not support suffix argument. Use app.add_source_suffix() instead.
    app.add_source_parser(suffix, parser)                                                                                                                                                     
  /work/llvm.monorepo/flang/docs/ArrayComposition.md:1: WARNING: The "contents" directive may not be used within topics or body elements.                                 
  /work/llvm.monorepo/flang/docs/BijectiveInternalNameUniquing.md:1: WARNING: The "contents" directive may not be used within topics or body elements.           
  /work/llvm.monorepo/flang/docs/C++17.md:1: WARNING: The "contents" directive may not be used within topics or body elements.                                              
  /work/llvm.monorepo/flang/docs/C++style.md:1: WARNING: The "contents" directive may not be used within topics or body elements.                                            
  /work/llvm.monorepo/flang/docs/Calls.md:1: WARNING: The "contents" directive may not be used within topics or body elements.                                         
  /work/llvm.monorepo/flang/docs/Character.md:1: WARNING: The "contents" directive may not be used within topics or body elements.                              
  /work/llvm.monorepo/flang/docs/ControlFlowGraph.md:1: WARNING: The "contents" directive may not be used within topics or body elements.                       
  /work/llvm.monorepo/flang/docs/Extensions.md:1: WARNING: The "contents" directive may not be used within topics or body elements.                         
  /work/llvm.monorepo/flang/docs/FortranForCProgrammers.md:1: WARNING: The "contents" directive may not be used within topics or body elements.            
  /work/llvm.monorepo/flang/docs/FortranIR.md:1: WARNING: The "contents" directive may not be used within topics or body elements.                                      

  Exception occurred:                                                                                                                                                                         
    File "/usr/lib/python3/dist-packages/recommonmark/states.py", line 128, in run_role                                                                                                       
      vec, msg = role_fn(name,                                                                                                                                                                
  TypeError: 'NoneType' object is not callable

I think it's only the last part that's actually a critical error, and I think what brought this on is the use of the AutoStructify thing.

Some searching suggests this is due to incompatibilities between certain sphinx and recommonmark versions (e.g. https://github.com/sphinx-doc/sphinx/issues/3800) but I really don't have time to debug this kind of stuff.

For now, my plan is to exclude the Flang docs from the build and link to the release notes as rendered by github here: https://github.com/llvm/llvm-project/blob/release/11.x/flang/docs/ReleaseNotes.md

If someone wants to fix the build, or even just send me the built html files once the release is ready, that would of course work too.

But I don't have time to fiddle around with these python packages, sorry.

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D87242/new/

https://reviews.llvm.org/D87242