Lines Matching +full:docs +full:- +full:llvm +full:- +full:man
1 OpenMP LLVM Documentation
4 OpenMP LLVM's documentation is written in reStructuredText, a lightweight
8 system to create HTML pages which are hosted on <https://llvm.org/docs/> and
12 Sphinx <http://sphinx-doc.org/> and then do:
14 cd <build-dir>
15 …cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true -DCMAKE_MODULE_PATH=/path/to/llvm/cmake/…
16 make docs-openmp-html
17 $BROWSER <build-dir>/docs/html/index.html
20 `docs/Foo.rst` <-> `<build-dir>/projects/openmp/docs//html/Foo.html` <->
21 `https://openmp.llvm.org/docs/Foo.html`.
24 `llvm/docs/SphinxQuickstartTemplate.rst` which will get you writing
32 primary difference is to use the `man` makefile target, instead of the
33 default (which is `html`). Sphinx then produces the man pages in the
34 directory `<build-dir>/docs/man/`.
36 cd <build-dir>
37 cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
39 man -l >build-dir>/docs/man/FileCheck.1
41 The correspondence between .rst files and man pages is
42 `docs/CommandGuide/Foo.rst` <-> `<build-dir>/projects/openmp/docs//man/Foo.1`.
45 `https://openmp.llvm.org/docs/CommandGuide/Foo.html`.