Add support to generate Sphinx DOCX documentation

[ldionne]

Summary

Add support for Sphinx docx builder. Requires Sphinx docx builder to be
installed using pip install docxbuilder.

Added SPHINX_OUTPUT_DOCX CMake variable to control generation of docx
documentation. Defaults to OFF.

Added <project>_INSTALL_SPHINX_DOCX_DIR CMake variable to control where docx
files are installed. Defaults to share/doc/<project>/<project>.docx.

Documented new CMake variables in llvm/docs/CMake.rst.

Updated description of building documentation is lld/docs/sphinx_intro.rst,
lldb/docs/resources/build.rst, llvm/docs/README.txt, and
openmp/docs/README.txt,

Update clang/docs/CMakeLists.txt for Sphinx man and docx builders to ensure
.td generated .rst files are available to prevent warnings of missing rst files.
Minor CMake cleanups.

Added docx as an additional target for the documentation make.bat scripts.

Added docx as an additional target rule in the Makefile.sphinx files.

[ldionne]

What's the benefit of having docx documentation? We generate HTML documentation, which ends up in the website, and that seems strictly superior to generating docx. What do you need it for?

The libc++ changes are almost trivial so I would not object to the change on that basis, however in general I think it's better to avoid adding support for things we won't be using on a regular basis.

[t-tye]

Split change for clang makefile to elimnate Sphinx warnings of missing .rst fies when building man pages into D106734.

[t-tye]

Factor out documentation and CMake file changes unrelated to adding DOCX support to D106736.

[t-tye]

In D106339#2890258, @ldionne wrote:

What's the benefit of having docx documentation? We generate HTML documentation, which ends up in the website, and that seems strictly superior to generating docx. What do you need it for?

The libc++ changes are almost trivial so I would not object to the change on that basis, however in general I think it's better to avoid adding support for things we won't be using on a regular basis.

We do have a project that requires docx documentation that includes parts of the LLVM documentation, so being able to generate it from the build is helpful. However, if adding docx support is not useful to anyone else then the changes can be kept out of tree.

A few observations are that the makefile.bat and Makefile.sphinx files already appear to support many of the build targets supported by Sphinx, so adding docx did not seem out of place. Building docx as part of the LLVM build is disabled by default so has no impact unless explicitly enabled. The changes to support it appeared fairly minor.

The changes not directly related to adding docx support have been split out to D106338, D106734 and D106736 which may be worth considering independent of whether this review is useful.

[MaskRay]

I remember that we even converted some *.md to *.rst to remove the number of supported documentation formats, so I agree that adding support the even less used *.docx may not be the proper direction.

Thanks for splitting this off.

[ldionne]

If there is no plan to move forward with generating .docx documentation, can we please abandon this review? I'm trying to clean up libc++'s review queue.

[ldionne]

Removing from the runtimes review queue -- please ping me directly if you need my attention on this.

_edit_: It looks like Herald won't let me do that.

[ldionne]

[GitHub PR transition cleanup]

This has been open for 2 years with multiple subscribers able to see this discussion, but there doesn't seem to be a lot of interest for moving forward with this. I will commandeer and abandon to clear the review queue in the context of moving to Github PRs. If you'd still like to push for this to happen, feel free to re-open this as a Github PR.

clang-tools-extra/docs/CMakeLists.txt

if (LLVM_ENABLE_SPHINX)
   include(AddSphinxTarget)
   if (SPHINX_FOUND)
     if (${SPHINX_OUTPUT_HTML})
       add_sphinx_target(html clang-tools)
     endif()
     if (${SPHINX_OUTPUT_MAN})
       add_sphinx_target(man clang-tools)
     endif()
+    if (${SPHINX_OUTPUT_DOCX})
+      add_sphinx_target(docx clang-tools)
+    endif()
   endif()
 endif()

clang-tools-extra/docs/conf.py

 
 # 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
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax']
 
+if tags.has('builder-docx'):
+    extensions.append('docxbuilder')
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

clang-tools-extra/docs/make.bat

if "%1" == "help" (
   echo.  htmlhelp   to make HTML files and a HTML help project
   echo.  qthelp     to make HTML files and a qthelp project
   echo.  devhelp    to make HTML files and a Devhelp project
   echo.  epub       to make an epub
   echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
   echo.  text       to make text files
   echo.  man        to make manual pages
   echo.  texinfo    to make Texinfo files
+  echo.  docx       to make DOCX files
   echo.  gettext    to make PO message catalogs
   echo.  changes    to make an overview over all changed/added/deprecated items
   echo.  linkcheck  to check all external links for integrity
   echo.  doctest    to run all doctests embedded in the documentation if enabled
   goto end
 )
 
 if "%1" == "clean" (

 if "%1" == "texinfo" (
   %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
   if errorlevel 1 exit /b 1
   echo.
   echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
   goto end
 )
 
+if "%1" == "docx" (
+  %SPHINXBUILD% -b docx %ALLSPHINXOPTS% %BUILDDIR%/docx
+  if errorlevel 1 exit /b 1
+  echo.
+  echo.Build finished. The DOCX files are in %BUILDDIR%/docx.
+  goto end
+)
+
 if "%1" == "gettext" (
   %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
   if errorlevel 1 exit /b 1
   echo.
   echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
   goto end
 )
 

clang/docs/CMakeLists.txt

if (SPHINX_FOUND)
 
     endif()
 
     if (${SPHINX_OUTPUT_MAN})
       add_sphinx_target(man clang SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}")
       add_dependencies(docs-clang-man copy-clang-rst-docs)
     endif()
 
+    if (${SPHINX_OUTPUT_DOCX})
+      add_sphinx_target(docx clang SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}")
+      add_dependencies(docs-clang-docx copy-clang-rst-docs)
+    endif()
+
   endif()
 endif()

clang/docs/Makefile.sphinx

help:
   @echo "  qthelp     to make HTML files and a qthelp project"
   @echo "  devhelp    to make HTML files and a Devhelp project"
   @echo "  epub       to make an epub"
   @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
   @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
   @echo "  text       to make text files"
   @echo "  man        to make manual pages"
   @echo "  texinfo    to make Texinfo files"
+  @echo "  docx       to make DOCX files"
   @echo "  info       to make Texinfo files and run them through makeinfo"
   @echo "  gettext    to make PO message catalogs"
   @echo "  changes    to make an overview of all changed/added/deprecated items"
   @echo "  linkcheck  to check all external links for integrity"
   @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 
 clean:
   -rm -rf $(BUILDDIR)/*

 
 texinfo:
   $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
   @echo
   @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
   @echo "Run \`make' in that directory to run these through makeinfo" \
         "(use \`make info' here to do that automatically)."
 
+docx:
+  $(SPHINXBUILD) -b docx $(ALLSPHINXOPTS) $(BUILDDIR)/docx
+  @echo
+  @echo "Build finished. The DOCX files are in $(BUILDDIR)/docx."
+
 info:
   $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
   @echo "Running Texinfo files through makeinfo..."
   make -C $(BUILDDIR)/texinfo info
   @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
 
 gettext:
   $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale

clang/docs/analyzer/conf.py

 
 # 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
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax']
 
+if tags.has('builder-docx'):
+    extensions.append('docxbuilder')
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

clang/docs/analyzer/make.bat

if "%1" == "help" (
   echo.  htmlhelp   to make HTML files and a HTML help project
   echo.  qthelp     to make HTML files and a qthelp project
   echo.  devhelp    to make HTML files and a Devhelp project
   echo.  epub       to make an epub
   echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
   echo.  text       to make text files
   echo.  man        to make manual pages
   echo.  texinfo    to make Texinfo files
+  echo.  docx       to make DOCX files
   echo.  gettext    to make PO message catalogs
   echo.  changes    to make an overview over all changed/added/deprecated items
   echo.  linkcheck  to check all external links for integrity
   echo.  doctest    to run all doctests embedded in the documentation if enabled
   goto end
 )
 
 if "%1" == "clean" (

 if "%1" == "texinfo" (
   %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
   if errorlevel 1 exit /b 1
   echo.
   echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
   goto end
 )
 
+if "%1" == "docx" (
+  %SPHINXBUILD% -b docx %ALLSPHINXOPTS% %BUILDDIR%/docx
+  if errorlevel 1 exit /b 1
+  echo.
+  echo.Build finished. The DOCX files are in %BUILDDIR%/docx.
+  goto end
+)
+
 if "%1" == "gettext" (
   %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
   if errorlevel 1 exit /b 1
   echo.
   echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
   goto end
 )
 

clang/docs/conf.py

 
 # 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
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax']
 
+if tags.has('builder-docx'):
+    extensions.append('docxbuilder')
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

clang/docs/make.bat

if "%1" == "help" (
   echo.  htmlhelp   to make HTML files and a HTML help project
   echo.  qthelp     to make HTML files and a qthelp project
   echo.  devhelp    to make HTML files and a Devhelp project
   echo.  epub       to make an epub
   echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
   echo.  text       to make text files
   echo.  man        to make manual pages
   echo.  texinfo    to make Texinfo files
+  echo.  docx       to make DOCX files
   echo.  gettext    to make PO message catalogs
   echo.  changes    to make an overview over all changed/added/deprecated items
   echo.  linkcheck  to check all external links for integrity
   echo.  doctest    to run all doctests embedded in the documentation if enabled
   goto end
 )
 
 if "%1" == "clean" (

 if "%1" == "texinfo" (
   %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
   if errorlevel 1 exit /b 1
   echo.
   echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
   goto end
 )
 
+if "%1" == "docx" (
+  %SPHINXBUILD% -b docx %ALLSPHINXOPTS% %BUILDDIR%/docx
+  if errorlevel 1 exit /b 1
+  echo.
+  echo.Build finished. The DOCX files are in %BUILDDIR%/docx.
+  goto end
+)
+
 if "%1" == "gettext" (
   %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
   if errorlevel 1 exit /b 1
   echo.
   echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
   goto end
 )
 

flang/docs/CMakeLists.txt

if (LLVM_ENABLE_SPHINX)
   include(AddSphinxTarget)
   if (SPHINX_FOUND)
     if (${SPHINX_OUTPUT_HTML})
       add_sphinx_target(html flang)
     endif()
     if (${SPHINX_OUTPUT_MAN})
       add_sphinx_target(man flang)
     endif()
+    if (${SPHINX_OUTPUT_DOCX})
+      add_sphinx_target(docx flang)
+    endif()
   endif()
 endif()
 

flang/docs/conf.py

 
 
 # 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
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.intersphinx']
 
+if tags.has('builder-docx'):
+    extensions.append('docxbuilder')
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = {
     '.rst': 'restructuredtext',
 }
 try:

libcxx/docs/CMakeLists.txt

 
 if (LLVM_ENABLE_SPHINX)
   include(AddSphinxTarget)
   if (SPHINX_FOUND)
     if (${SPHINX_OUTPUT_HTML})
       add_sphinx_target(html libcxx)
     endif()
+    if (${SPHINX_OUTPUT_DOCX})
+      add_sphinx_target(docx libcxx)
+    endif()
   endif()
 endif()

libcxx/docs/Makefile.sphinx

 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext default
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man docx changes linkcheck doctest gettext default
 
 default: html
 
 help:
   @echo "Please use \`make <target>' where <target> is one of"
   @echo "  html       to make standalone HTML files"
 
 clean:

libcxx/docs/conf.py

 
 # 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
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo']
 
+if tags.has('builder-docx'):
+    extensions.append('docxbuilder')
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

libunwind/docs/CMakeLists.txt

 include(FindSphinx)
 if (SPHINX_FOUND AND LLVM_ENABLE_SPHINX)
   include(AddSphinxTarget)
   if (${SPHINX_OUTPUT_HTML})
     add_sphinx_target(html libunwind)
   endif()
+  if (${SPHINX_OUTPUT_DOCX})
+    add_sphinx_target(docx libunwind)
+  endif()
 endif()

libunwind/docs/conf.py

 
 # 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
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo']
 
+if tags.has('builder-docx'):
+    extensions.append('docxbuilder')
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

lld/docs/CMakeLists.txt

 if (LLVM_ENABLE_SPHINX)
   include(AddSphinxTarget)
   if (SPHINX_FOUND)
     if (${SPHINX_OUTPUT_HTML})
       add_sphinx_target(html lld)
     endif()
+    if (${SPHINX_OUTPUT_DOCX})
+      add_sphinx_target(docx lld)
+    endif()
   endif()
 endif()

lld/docs/conf.py

 
 # 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
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo']
 
+if tags.has('builder-docx'):
+    extensions.append('docxbuilder')
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

lld/docs/make.bat

if "%1" == "help" (
   echo.  htmlhelp   to make HTML files and a HTML help project
   echo.  qthelp     to make HTML files and a qthelp project
   echo.  devhelp    to make HTML files and a Devhelp project
   echo.  epub       to make an epub
   echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
   echo.  text       to make text files
   echo.  man        to make manual pages
   echo.  texinfo    to make Texinfo files
+  echo.  docx       to make DOCX files
   echo.  gettext    to make PO message catalogs
   echo.  changes    to make an overview over all changed/added/deprecated items
   echo.  linkcheck  to check all external links for integrity
   echo.  doctest    to run all doctests embedded in the documentation if enabled
   goto end
 )
 
 if "%1" == "clean" (

 if "%1" == "texinfo" (
   %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
   if errorlevel 1 exit /b 1
   echo.
   echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
   goto end
 )
 
+if "%1" == "docx" (
+  %SPHINXBUILD% -b docx %ALLSPHINXOPTS% %BUILDDIR%/docx
+  if errorlevel 1 exit /b 1
+  echo.
+  echo.Build finished. The DOCX files are in %BUILDDIR%/docx.
+  goto end
+)
+
 if "%1" == "gettext" (
   %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
   if errorlevel 1 exit /b 1
   echo.
   echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
   goto end
 )
 

lld/docs/sphinx_intro.rst

to install it using:
   macOS
     All modern macOS systems come with ``easy_install`` as part of the base
     system.
 
   Windows
     See the `setuptools <http://pypi.python.org/pypi/setuptools>`_ package web
     page for instructions.
 
+If building DOCX documentation, then the Sphinx DOCX builder must be installed
+using ``pip install docxbuilder``.
 
 .. _building_the_documentation:
 
 Building the documentation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In order to build the documentation need to add ``-DLLVM_ENABLE_SPHINX=ON`` to
 your ``cmake`` command.  Once you do this you can build the docs using

lldb/docs/CMakeLists.txt

add_custom_target(clean-lldb-html COMMAND "${CMAKE_COMMAND}" -E
       remove_directory ${CMAKE_CURRENT_BINARY_DIR}/html)
     add_dependencies(docs-lldb-html swig_wrapper_python
                      lldb-python-doc-package clean-lldb-html)
   endif()
 
   if (${SPHINX_OUTPUT_MAN})
     add_sphinx_target(man lldb)
   endif()
+
+  if (${SPHINX_OUTPUT_DOCX})
+    add_sphinx_target(docx lldb)
+  endif()
+
 endif()

lldb/docs/conf.py

 
 # 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
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.intersphinx']
 
+if tags.has('builder-docx'):
+    extensions.append('docxbuilder')
+
 autodoc_default_options = {
     'special-members': '__int__, __len__, __hex__, __oct__, __iter__',
 }
 
 # Unless we only generate the basic manpage we need the plugin for generating
 # the Python API documentation.
 if not building_man_page:
     extensions.append('sphinx_automodapi.automodapi')

lldb/docs/resources/build.rst

 
 To install the prerequisites for building the documentation (on Debian/Ubuntu)
 do:
 
 ::
 
   > sudo apt-get install doxygen graphviz python3-sphinx
   > sudo pip install epydoc
+  > sudo pip install docxbuilder
 
 To build the documentation, configure with ``LLVM_ENABLE_SPHINX=ON`` and build the desired target(s).
 
 ::
 
   > ninja docs-lldb-html
   > ninja docs-lldb-man
+  > ninja docs-lldb-docx
   > ninja lldb-cpp-doc
   > ninja lldb-python-doc
 
 Cross-compiling LLDB
 --------------------
 
 In order to debug remote targets running different architectures than your
 host, you will need to compile LLDB (or at least the server component) for the

llvm/cmake/modules/AddSphinxTarget.cmake

if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
                 COMPONENT "${project}-sphinx-html"
                 DESTINATION "$CACHE{${project_upper}_INSTALL_SPHINX_HTML_DIR}")
 
         if(NOT LLVM_ENABLE_IDE)
           add_llvm_install_targets("install-${SPHINX_TARGET_NAME}"
                                    DEPENDS ${SPHINX_TARGET_NAME}
                                    COMPONENT "${project}-sphinx-html")
         endif()
+      elseif (builder STREQUAL docx)
+        string(TOUPPER "${project}" project_upper)
+        set(${project_upper}_INSTALL_SPHINX_DOCX_DIR "${CMAKE_INSTALL_DATADIR}/doc/${project}"
+            CACHE STRING "DOCX documentation install directory for ${project}")
+
+        install(DIRECTORY "${SPHINX_BUILD_DIR}/"  # Slash indicates contents of
+                COMPONENT "${project}-sphinx-docx"
+                DESTINATION "$CACHE{${project_upper}_INSTALL_SPHINX_DOCX_DIR}")
+
+        if(NOT LLVM_ENABLE_IDE)
+          add_llvm_install_targets("install-${SPHINX_TARGET_NAME}"
+                                   DEPENDS "${SPHINX_TARGET_NAME}"
+                                   COMPONENT "${project}-sphinx-docx")
+        endif()
       else()
         message(WARNING Installation of ${builder} not supported)
       endif()
     endif()
   endif()
 endfunction()

llvm/cmake/modules/FindSphinx.cmake

 include(FindPackageHandleStandardArgs)
 find_package_handle_standard_args(Sphinx
                                   "Failed to locate sphinx-build executable"
                                   SPHINX_EXECUTABLE)
 
 # Provide options for controlling different types of output
 option(SPHINX_OUTPUT_HTML "Output standalone HTML files" ON)
 option(SPHINX_OUTPUT_MAN "Output man pages" ON)
+option(SPHINX_OUTPUT_DOCX "Output DOCX files" OFF)
 
 option(SPHINX_WARNINGS_AS_ERRORS "When building documentation treat warnings as errors" ON)

llvm/docs/CMake.rst

**LLVM_ENABLE_PROJECTS**:STRING
   The full list is:
   ``clang;clang-tools-extra;compiler-rt;cross-project-tests;libc;libclc;libcxx;libcxxabi;libunwind;lld;lldb;openmp;parallel-libs;polly;pstl``
 
 **LLVM_ENABLE_RTTI**:BOOL
   Build LLVM with run-time type information. Defaults to OFF.
 
 **LLVM_ENABLE_SPHINX**:BOOL
   If specified, CMake will search for the ``sphinx-build`` executable and will make
-  the ``SPHINX_OUTPUT_HTML`` and ``SPHINX_OUTPUT_MAN`` CMake options available.
-  Defaults to OFF.
+  the ``SPHINX_OUTPUT_HTML``, ``SPHINX_OUTPUT_MAN`` and ``SPHINX_OUTPUT_DOCX`` CMake options
+  available. Defaults to OFF.
 
 **LLVM_ENABLE_THREADS**:BOOL
   Build with threads support, if available. Defaults to ON.
 
 **LLVM_ENABLE_UNWIND_TABLES**:BOOL
   Enable unwind tables in the binary.  Disabling unwind tables can reduce the
   size of the libraries.  Defaults to ON.
 
 **LLVM_ENABLE_WARNINGS**:BOOL
   Enable all compiler warnings. Defaults to ON.
 
 **LLVM_ENABLE_WERROR**:BOOL
   Stop and fail the build, if a compiler warning is triggered. Defaults to OFF.
 
 **LLVM_ENABLE_Z3_SOLVER**:BOOL
   If enabled, the Z3 constraint solver is activated for the Clang static analyzer.
   A recent version of the z3 library needs to be available on the system.
 
 **LLVM_ENABLE_ZLIB**:BOOL
   Enable building with zlib to support compression/uncompression in LLVM tools.
   Defaults to ON.
 
 **LLVM_EXPERIMENTAL_TARGETS_TO_BUILD**:STRING
-  Semicolon-separated list of experimental targets to build and linked into 
-  llvm. This will build the experimental target without needing it to add to the 
+  Semicolon-separated list of experimental targets to build and linked into
+  llvm. This will build the experimental target without needing it to add to the
   list of all the targets available in the LLVM's main CMakeLists.txt.
 
 **LLVM_EXTERNAL_{CLANG,LLD,POLLY}_SOURCE_DIR**:PATH
   These variables specify the path to the source directory for the external
   LLVM projects Clang, lld, and Polly, respectively, relative to the top-level
   source directory.  If the in-tree subdirectory for an external project
   exists (e.g., llvm/tools/clang for Clang), then the corresponding variable
   will not be used.  If the variable for an external project does not point
**LLVM_INSTALL_OCAMLDOC_HTML_DIR**:STRING
   either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
   `share/doc/llvm/ocaml-html`.
 
 **LLVM_INSTALL_SPHINX_HTML_DIR**:STRING
   The path to install Sphinx-generated HTML documentation to. This path can
   either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
   `share/doc/llvm/html`.
 
+**LLVM_INSTALL_SPHINX_DOCX_DIR**:STRING
+  The path to install Sphinx-generated DOCX documentation to. This path can
+  either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
+  `share/doc/llvm`.
+
 **LLVM_INSTALL_UTILS**:BOOL
   If enabled, utility binaries like ``FileCheck`` and ``not`` will be installed
   to CMAKE_INSTALL_PREFIX.
 
 **LLVM_INTEGRATED_CRT_ALLOC**:PATH
   On Windows, allows embedding a different C runtime allocator into the LLVM
   tools and libraries. Using a lock-free allocator such as the ones listed below
   greatly decreases ThinLTO link time by about an order of magnitude. It also
   midly improves Clang build times, by about 5-10%. At the moment, rpmalloc,
   snmalloc and mimalloc are supported. Use the path to `git clone` to select
   the respective allocator, for example:
 
   .. code-block:: console
 
     $ D:\git> git clone https://github.com/mjansson/rpmalloc
     $ D:\llvm-project> cmake ... -DLLVM_INTEGRATED_CRT_ALLOC=D:\git\rpmalloc
-  
   This flag needs to be used along with the static CRT, ie. if building the
   Release target, add -DLLVM_USE_CRT_RELEASE=MT.
 
 **LLVM_INSTALL_DOXYGEN_HTML_DIR**:STRING
   The path to install Doxygen-generated HTML documentation to. This path can
   either be absolute or relative to the CMAKE_INSTALL_PREFIX. Defaults to
   `share/doc/llvm/doxygen-html`.
 
**SPHINX_OUTPUT_HTML**:BOOL
   and ``docs-lld-html``). Defaults to ON.
 
 **SPHINX_OUTPUT_MAN**:BOOL
   If enabled (and ``LLVM_ENABLE_SPHINX`` is enabled) the targets for building
   the man pages are added (but not built by default unless ``LLVM_BUILD_DOCS``
   is enabled). Currently the only target added is ``docs-llvm-man``. Defaults
   to ON.
 
+**SPHINX_OUTPUT_DOCX**:BOOL
+  If enabled (and ``LLVM_ENABLE_SPHINX`` is enabled) the targets for building
+  the DOCX files are added (but not built by default unless ``LLVM_BUILD_DOCS``
+  is enabled). Requires that the Sphinx DOCX builder is installed using ``pip
+  install docxbuilder``. Currently the only target added is ``docs-llvm-docx``.
+  Defaults to OFF.
+
 **SPHINX_WARNINGS_AS_ERRORS**:BOOL
   If enabled then sphinx documentation warnings will be treated as
   errors. Defaults to ON.
 
 CMake Caches
 ============
 
 Recently LLVM and Clang have been adding some more complicated build system

llvm/docs/CMakeLists.txt

 
 if (LLVM_ENABLE_SPHINX)
   include(AddSphinxTarget)
   if (SPHINX_FOUND)
     if (${SPHINX_OUTPUT_HTML})
       add_sphinx_target(html llvm)
     endif()
 
-
     if (${SPHINX_OUTPUT_MAN})
       add_sphinx_target(man llvm)
       add_sphinx_target(man llvm-dwarfdump)
       add_sphinx_target(man dsymutil)
     endif()
 
+    if (${SPHINX_OUTPUT_DOCX})
+      add_sphinx_target(docx llvm)
+    endif()
+
   endif()
 endif()
 
 list(FIND LLVM_BINDINGS_LIST ocaml uses_ocaml)
 if( NOT uses_ocaml LESS 0 AND LLVM_ENABLE_OCAMLDOC )
   set(doc_targets
         ocaml_llvm
         ocaml_llvm_all_backends

llvm/docs/Makefile.sphinx

 # Makefile for Sphinx documentation
 #
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext docx
 
 all:  html
 
 help:
   @echo "Please use \`make <target>' where <target> is one of"
   @echo "  html       to make standalone HTML files"
   @echo "  dirhtml    to make HTML files named index.html in directories"
   @echo "  singlehtml to make a single large HTML file"
   @echo "  pickle     to make pickle files"
   @echo "  json       to make JSON files"
   @echo "  htmlhelp   to make HTML files and a HTML help project"
   @echo "  qthelp     to make HTML files and a qthelp project"
   @echo "  devhelp    to make HTML files and a Devhelp project"
   @echo "  epub       to make an epub"
   @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
   @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
   @echo "  text       to make text files"
   @echo "  man        to make manual pages"
   @echo "  texinfo    to make Texinfo files"
+  @echo "  docx       to make DOCX files"
   @echo "  info       to make Texinfo files and run them through makeinfo"
   @echo "  gettext    to make PO message catalogs"
   @echo "  changes    to make an overview of all changed/added/deprecated items"
   @echo "  linkcheck  to check all external links for integrity"
   @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 
 clean:
   -rm -rf $(BUILDDIR)/*

 
 texinfo:
   $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
   @echo
   @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
   @echo "Run \`make' in that directory to run these through makeinfo" \
         "(use \`make info' here to do that automatically)."
 
+docx:
+  $(SPHINXBUILD) -b docx $(ALLSPHINXOPTS) $(BUILDDIR)/docx
+  @echo
+  @echo "Build finished. The DOCX files are in $(BUILDDIR)/docx."
+
 info:
   $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
   @echo "Running Texinfo files through makeinfo..."
   make -C $(BUILDDIR)/texinfo info
   @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
 
 gettext:
   $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale

llvm/docs/README.txt

 viewable online:
 
 LLVM project
     `https://llvm.org/docs/CommandGuide/Foo.html`
 
 Other projects
     `https://<project>.llvm.org/docs/CommandGuide/Foo.html`
 
+DOCX Output
+===========
+
+Building the DOCX files is similar to building the HTML documentation. The
+primary difference is to use the `docx` makefile target, instead of the
+default (which is `html`). Sphinx then produces the DOCX files in the
+directory `<build-dir>/docs/docx/`.
+
+    cd <build-dir>
+    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_DOCX=true <src-dir>
+    make -j3 docs-llvm-docx
+
+The correspondence between reStructuredText files and generated DOCX files is:
+
+LLVM project
+    `llvm/docs/index.rst` <-> `<build-dir>/docs/docx/LLVM.docx` <-> `<install-dir>/share/doc/llvm/LLVM.docx`
+
+Other projects
+    `<project>/docs/index.rst` <-> `<build-dir>/tools/<project>/docs/docx/<project>.docx` <-> `<install-dir>/share/doc/<project>/<project>.docx`
+
 Checking links
 ==============
 
 The reachability of external links in the documentation can be checked by
 running:
 
     cd docs/
     make -f Makefile.sphinx linkcheck

llvm/docs/conf.py

 
 # 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
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo']
 
+if tags.has('builder-docx'):
+    extensions.append('docxbuilder')
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = {
     '.rst': 'restructuredtext',
 }
 

llvm/docs/make.bat

if "%1" == "help" (
   echo.  htmlhelp   to make HTML files and a HTML help project
   echo.  qthelp     to make HTML files and a qthelp project
   echo.  devhelp    to make HTML files and a Devhelp project
   echo.  epub       to make an epub
   echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
   echo.  text       to make text files
   echo.  man        to make manual pages
   echo.  texinfo    to make Texinfo files
+  echo.  docx       to make DOCX files
   echo.  gettext    to make PO message catalogs
   echo.  changes    to make an overview over all changed/added/deprecated items
   echo.  linkcheck  to check all external links for integrity
   echo.  doctest    to run all doctests embedded in the documentation if enabled
   goto end
 )
 
 if "%1" == "clean" (

 if "%1" == "texinfo" (
   %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
   if errorlevel 1 exit /b 1
   echo.
   echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
   goto end
 )
 
+if "%1" == "docx" (
+  %SPHINXBUILD% -b docx %ALLSPHINXOPTS% %BUILDDIR%/docx
+  if errorlevel 1 exit /b 1
+  echo.
+  echo.Build finished. The DOCX files are in %BUILDDIR%/docx.
+  goto end
+)
+
 if "%1" == "gettext" (
   %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
   if errorlevel 1 exit /b 1
   echo.
   echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
   goto end
 )
 

openmp/docs/CMakeLists.txt

if (LLVM_ENABLE_SPHINX)
   include(AddSphinxTarget)
   if (SPHINX_FOUND)
     if (${SPHINX_OUTPUT_HTML})
       add_sphinx_target(html openmp)
     endif()
     if (${SPHINX_OUTPUT_MAN})
       add_sphinx_target(man openmp)
     endif()
+    if (${SPHINX_OUTPUT_DOCX})
+      add_sphinx_target(docx openmp)
+    endif()
   endif()
 endif()

openmp/docs/README.txt

 These .rst files are also included during HTML generation so they are also
 viewable online:
 
 LLVM project
     `https://openmp.llvm.org/docs/CommandGuide/Foo.html`
 
 Other projects (such as openmp)
     `https://<project>.llvm.org/docs/CommandGuide/Foo.html`
+
+DOCX Output
+===========
+
+Building the DOCX files is similar to building the HTML documentation. The
+primary difference is to use the `docx` makefile target, instead of the
+default (which is `html`). Sphinx then produces the DOCX files in the
+directory `<build-dir>/docs/docx/`.
+
+    cd <build-dir>
+    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_DOCX=true <src-dir>
+    make
+
+The correspondence between reStructuredText files and generated DOCX files is:
+
+LLVM project
+    `llvm/docs/index.rst` <-> `<build-dir>/docs/docx/LLVM.docx` <-> `<install-dir>/share/doc/llvm/LLVM.docx`
+
+Other projects
+    `<project>/docs/index.rst` <-> `<build-dir>/tools/<project>/docs/docx/<project>.docx` <-> `<install-dir>/share/doc/<project>/<project>.docx`

openmp/docs/conf.py

 
 # 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
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.intersphinx']
 
+if tags.has('builder-docx'):
+    extensions.append('docxbuilder')
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

polly/docs/CMakeLists.txt

if (LLVM_ENABLE_SPHINX)
   include(AddSphinxTarget)
   if (SPHINX_FOUND)
     if (${SPHINX_OUTPUT_HTML})
       add_sphinx_target(html polly)
     endif()
     if (${SPHINX_OUTPUT_MAN})
       add_sphinx_target(man polly)
     endif()
+    if (${SPHINX_OUTPUT_DOCX})
+      add_sphinx_target(docx polly)
+    endif()
   endif()
 endif()
 

polly/docs/conf.py

 
 # 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
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax']
 
+if tags.has('builder-docx'):
+    extensions.append('docxbuilder')
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'