Mercurial > hg > CbC > CbC_llvm
diff docs/README.txt @ 120:1172e4bd9c6f
update 4.0.0
author | mir3636 |
---|---|
date | Fri, 25 Nov 2016 19:14:25 +0900 |
parents | afa8332a0e37 |
children | 803732b1fca8 |
line wrap: on
line diff
--- a/docs/README.txt Tue Jan 26 22:56:36 2016 +0900 +++ b/docs/README.txt Fri Nov 25 19:14:25 2016 +0900 @@ -11,12 +11,13 @@ If you instead would like to generate and view the HTML locally, install Sphinx <http://sphinx-doc.org/> and then do: - cd docs/ - make -f Makefile.sphinx - $BROWSER _build/html/index.html + cd <build-dir> + cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir> + make -j3 docs-llvm-html + $BROWSER <build-dir>/docs//html/index.html The mapping between reStructuredText files and generated documentation is -`docs/Foo.rst` <-> `_build/html/Foo.html` <-> `http://llvm.org/docs/Foo.html`. +`docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `http://llvm.org/docs/Foo.html`. If you are interested in writing new documentation, you will want to read `SphinxQuickstartTemplate.rst` which will get you writing documentation @@ -29,14 +30,15 @@ Building the manpages is similar to building the HTML documentation. The primary difference is to use the `man` makefile target, instead of the default (which is `html`). Sphinx then produces the man pages in the -directory `_build/man/`. +directory `<build-dir>/docs/man/`. - cd docs/ - make -f Makefile.sphinx man - man -l _build/man/FileCheck.1 + cd <build-dir> + cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir> + make -j3 docs-llvm-man + man -l >build-dir>/docs/man/FileCheck.1 The correspondence between .rst files and man pages is -`docs/CommandGuide/Foo.rst` <-> `_build/man/Foo.1`. +`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`. These .rst files are also included during HTML generation so they are also viewable online (as noted above) at e.g. `http://llvm.org/docs/CommandGuide/Foo.html`.