Skip to content

Commit

Permalink
[docs] Update doc building instructions
Browse files Browse the repository at this point in the history
Differential Revision: https://reviews.llvm.org/D39984

llvm-svn: 319857
  • Loading branch information
sbc100 committed Dec 5, 2017
1 parent c3e16d6 commit e8a4d5f
Showing 1 changed file with 6 additions and 26 deletions.
32 changes: 6 additions & 26 deletions lld/docs/sphinx_intro.rst
Expand Up @@ -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:

Expand Down

0 comments on commit e8a4d5f

Please sign in to comment.