From e84f5ca2ea4e7cd16cbf6ed21b822fa48dc1432c Mon Sep 17 00:00:00 2001 From: Daniel Dunbar Date: Fri, 6 Apr 2012 23:55:50 +0000 Subject: [PATCH] [docs] Note that 'make.bat' provides the same interface as the Makefile for Windows users. llvm-svn: 154229 --- lld/docs/sphinx_intro.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/lld/docs/sphinx_intro.rst b/lld/docs/sphinx_intro.rst index 9a8b289b6690..d729c2debc98 100644 --- a/lld/docs/sphinx_intro.rst +++ b/lld/docs/sphinx_intro.rst @@ -63,9 +63,13 @@ In order to build the documentation, all you should need to do is change to the $ cd path/to/project/docs $ make html -which 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``. +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 @@ -74,10 +78,10 @@ targets for invoking ``sphinx-build`` appropriately, the common ones are: make html Generate the HTML output. - latexpdf + make latexpdf Generate LaTeX documentation and convert to a PDF. - man + make man Generate man pages.