diff options
| author | Philip Reames <listmail@philipreames.com> | 2016-02-07 15:42:12 +0000 |
|---|---|---|
| committer | Philip Reames <listmail@philipreames.com> | 2016-02-07 15:42:12 +0000 |
| commit | 06f008646175128cc0faa535175ccdcd018c46e2 (patch) | |
| tree | 820454a44c48ae8078ebfeacc6cb5a92a7948bf2 /docs/README.txt | |
| parent | fe2d3ebbd3d27214f835e117b4c3800ae7aed80f (diff) | |
[docs] Update the docs to describe how to build the docs with cmake
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@260035 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/README.txt')
| -rw-r--r-- | docs/README.txt | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/README.txt b/docs/README.txt index 31764b2951b2..6c6e5b90ecf2 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -11,12 +11,13 @@ updated after every commit. Manpage output is also supported, see below. 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 @@ Manpage Output 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`. |