[lld] r319857 - [docs] Update doc building instructions

Sam Clegg via llvm-commits llvm-commits at lists.llvm.org
Tue Dec 5 15:31:26 PST 2017


Author: sbc
Date: Tue Dec  5 15:31:26 2017
New Revision: 319857

URL: http://llvm.org/viewvc/llvm-project?rev=319857&view=rev
Log:
[docs] Update doc building instructions

Differential Revision: https://reviews.llvm.org/D39984

Modified:
    lld/trunk/docs/sphinx_intro.rst

Modified: lld/trunk/docs/sphinx_intro.rst
URL: http://llvm.org/viewvc/llvm-project/lld/trunk/docs/sphinx_intro.rst?rev=319857&r1=319856&r2=319857&view=diff
==============================================================================
--- lld/trunk/docs/sphinx_intro.rst (original)
+++ lld/trunk/docs/sphinx_intro.rst Tue Dec  5 15:31:26 2017
@@ -57,33 +57,13 @@ to install it using:
 Building the documentation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-In order to build the documentation, all you should need to do is change to the
-``docs`` directory and invoke make as follows::
-
-  $ cd path/to/project/docs
-  $ make html
-
-Note that on Windows there is a ``make.bat`` command in the docs directory which
-supplies the same interface as the ``Makefile``.
-
-That command will invoke ``sphinx-build`` with the appropriate options for the
-project, and generate the HTML documentation in a ``_build`` subdirectory. You
-can browse it starting from the index page by visiting
-``_build/html/index.html``.
-
-Sphinx supports a wide variety of generation formats (including LaTeX, man
-pages, and plain text). The ``Makefile`` includes a number of convenience
-targets for invoking ``sphinx-build`` appropriately, the common ones are:
-
-  make html
-    Generate the HTML output.
-
-  make latexpdf
-    Generate LaTeX documentation and convert to a PDF.
-
-  make man
-    Generate man pages.
-
+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
+``docs-lld-html`` build (``ninja`` or ``make``) target.
+
+That build target will invoke ``sphinx-build`` with the appropriate options for
+the project, and generate the HTML documentation in a ``tools/lld/docs/html``
+subdirectory.
 
 .. _writing_documentation:
 




More information about the llvm-commits mailing list