This is an archive of the discontinued LLVM Phabricator instance.

Differential D16963

Copy LibASTMatchersReference.html to gen'd docs
Needs ReviewPublic

Authored by sdowney on Feb 7 2016, 7:56 AM.
This revision needs review, but all reviewers have resigned.

Details

Reviewers
reames
Summary

The LibASTMatchersReference documentation is an html file, not an rst
document, so is not produced by sphinx. Copy the html into the proper
location as part of the sphinx html doc generation.




Also include a link to the AST Matcher Reference in the index.
Diff Detail
Event Timeline
sdowney updated this revision to Diff 47131.Feb 7 2016, 7:56 AM
sdowney retitled this revision from  to Copy LibASTMatchersReference.html to gen'd docs.
sdowney updated this object.
sdowney added a reviewer: reames.
sdowney added a subscriber: cfe-commits.
reames edited edge metadata.Feb 7 2016, 8:30 AM
This looks entirely reasonable to me, but I don't really know cmake.  Can someone with cmake knowledge take a quick look?
klimek added a subscriber: klimek.Feb 9 2016, 8:52 AM
I have fixed that in r260218 for LibASTMatcherReference (basically using the same mechanism, but only copying the one file). Not sure which is the better approach, I considered globbing, but my gut feeling decided against it :)

Definitely check in the link though.

Thanks!
sdowney added a subscriber: sdowney.Feb 9 2016, 9:18 AM
I'll push up a review with the one line link addition later. Thanks!



The html copy should also get applied to the release_38 branch too, if

there's going to be another RC.
reames resigned from this revision.Feb 25 2020, 9:02 AM
Resigning from a stale review (2016).  Feel free to re-add if thread ever revived.
Herald added subscribers: arphaman, mgorny.  ·  View Herald TranscriptFeb 25 2020, 9:02 AM
Revision Contents
PathSize
docs/
2 lines
2 lines
Diff 47131
docs/CMakeLists.txt
Show First 20 Lines • Show All 89 Lines • ▼ Show 20 Lines
endif()
endif()

endif()
endif()




if (LLVM_ENABLE_SPHINX)
if (LLVM_ENABLE_SPHINX)

  if (SPHINX_FOUND)
  if (SPHINX_FOUND)

    include(AddSphinxTarget)
    include(AddSphinxTarget)

    if (${SPHINX_OUTPUT_HTML})
    if (${SPHINX_OUTPUT_HTML})

      add_sphinx_target(html clang)
      add_sphinx_target(html clang)

      file(GLOB DOC_HTML *.html)

      file(COPY ${DOC_HTML} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/html)

    endif()
    endif()

    if (${SPHINX_OUTPUT_MAN})
    if (${SPHINX_OUTPUT_MAN})

      add_sphinx_target(man clang)
      add_sphinx_target(man clang)

    endif()
    endif()

  endif()
  endif()

endif()
endif()

docs/index.rst
Show First 20 Lines • Show All 46 Lines • ▼ Show 20 Lines.. toctree::

   ExternalClangExamples
   ExternalClangExamples

   IntroductionToTheClangAST
   IntroductionToTheClangAST

   LibTooling
   LibTooling

   LibFormat
   LibFormat

   ClangPlugins
   ClangPlugins

   RAVFrontendAction
   RAVFrontendAction

   LibASTMatchersTutorial
   LibASTMatchersTutorial

   LibASTMatchers
   LibASTMatchers

   LibASTMatchersReference

   HowToSetupToolingForLLVM
   HowToSetupToolingForLLVM

   JSONCompilationDatabase
   JSONCompilationDatabase




Using Clang Tools
Using Clang Tools

=================
=================




.. toctree::
.. toctree::

   :maxdepth: 1
   :maxdepth: 1

Show All 16 Lines






Indices and tables
Indices and tables

==================
==================




* :ref:`genindex`
* :ref:`genindex`

* :ref:`modindex`
* :ref:`modindex`

* :ref:`search`
* :ref:`search`