maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[docs] Note that 'make.bat' provides the same interface as the Makefile for 

Windows users.

llvm-svn: 154229
This commit is contained in:
Daniel Dunbar 2012-04-06 23:55:50 +00:00
parent eaa88c8f71
commit e84f5ca2ea
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
lld/docs/sphinx_intro.rst
View File

@ -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.