llvm/docs
Peter Zotov 225146951e [OCaml] (PR10016) Add a few missing line in OCamlLangImpl2.rst
Original patch by Damien Schoof

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@194067 91177308-0d34-0410-b5e6-96231b3b80d8
2013-11-05 12:14:04 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Add warning about CHECK-DAG with variable definition 2013-10-11 18:50:22 +00:00
HistoricalNotes [typo] An LLVM. 2013-08-16 23:30:19 +00:00
TableGen
tutorial [OCaml] (PR10016) Add a few missing line in OCamlLangImpl2.rst 2013-11-05 12:14:04 +00:00
AliasAnalysis.rst
Atomics.rst Small correction to unordered memory code generation of ARM LDRD 2013-06-18 23:07:16 +00:00
BitCodeFormat.rst Implement function prefix data as an IR feature. 2013-09-16 01:08:15 +00:00
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst docs: Update old VS 2008 references. 2013-07-23 17:44:01 +00:00
CMakeLists.txt [doxygen] Use correct variable names for external variable configuration and make EXTRA_SEARCH_MAPPINGS a "dumb" variable. 2013-08-28 21:55:26 +00:00
CodeGenerator.rst Add more documentation about the TargetStreamer interface. 2013-10-16 14:54:39 +00:00
CodingStandards.rst Revert r189704, which removed the guidance about not duplicating doc comments. 2013-09-01 15:48:08 +00:00
CommandLine.rst CommandLine.rst: remove tiny bit of bad mark-up 2013-07-10 22:09:22 +00:00
CompilerWriterInfo.rst [docs] Add link to 32-bit ARM ELF supplement. 2013-11-04 19:43:36 +00:00
conf.py We're in 3.4 land now. 2013-05-07 20:31:28 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst Developer policy amendment regarding confidentiality notices 2013-10-18 08:45:43 +00:00
doxygen.cfg.in [doxygen] Use correct variable names for external variable configuration and make EXTRA_SEARCH_MAPPINGS a "dumb" variable. 2013-08-28 21:55:26 +00:00
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
Dummy.html
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst Fix documentation on the path to Bitcode reader/writer 2013-06-11 18:09:21 +00:00
Extensions.rst Sphinx refuses to render this code block. Try adding a newline. 2013-08-14 16:18:47 +00:00
FAQ.rst
GarbageCollection.rst Remove reference to obsolete arguments. 2013-10-18 23:11:25 +00:00
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst Update the Python version. And Perl isn't used anymore. 2013-10-27 04:02:21 +00:00
GettingStartedVS.rst [typo] An LLVM. 2013-08-16 23:30:19 +00:00
GoldPlugin.rst Fix Sphinx warning. 2013-10-27 04:25:02 +00:00
HowToAddABuilder.rst
HowToBuildOnARM.rst Fix common typos in the docs. 2013-10-29 17:53:27 +00:00
HowToCrossCompileLLVM.rst [docs] Some typographical fixes. 2013-09-09 19:05:03 +00:00
HowToReleaseLLVM.rst Typo 2013-05-28 11:28:37 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
index.rst [docs] Fix some Sphinx toctree warnings. 2013-09-09 19:09:00 +00:00
LangRef.rst Remove linkonce_odr_auto_hide. 2013-11-01 17:09:14 +00:00
Lexicon.rst
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst Fix grammar in LLVMBuild.rst 2013-04-18 16:39:32 +00:00
LLVMBuild.txt
make.bat
Makefile docs: Remove incompatibility with Solaris shell 2013-10-15 08:30:07 +00:00
Makefile.sphinx
MakefileGuide.rst Remove stray '_'. 2013-10-28 21:43:54 +00:00
MarkedUpDisassembly.rst
MCJIT-creation.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-dyld-load.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-engine-builder.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-load-object.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-load.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-resolve-relocations.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJITDesignAndImplementation.rst Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
NVPTXUsage.rst
Packaging.rst
Passes.rst docs/Passes: fix some typos 2013-05-18 18:01:44 +00:00
Phabricator.rst Phabricator.rst: tiny fix 2013-07-25 22:58:31 +00:00
ProgrammersManual.rst IR headers moved to llvm/IR some aeons ago, update documentation. 2013-07-08 19:59:35 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst Add a release not about llvm-ar. 2013-08-06 13:16:28 +00:00
ReleaseProcess.rst Update Release Process doc 2013-06-12 11:35:33 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst Fix common typos in the docs. 2013-10-29 17:53:27 +00:00
SphinxQuickstartTemplate.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst Update the Python version. And Perl isn't used anymore. 2013-10-27 04:02:21 +00:00
TestSuiteMakefileGuide.rst
Vectorizers.rst Update the docs. 2013-08-05 04:27:34 +00:00
WritingAnLLVMBackend.rst TableGen: Enumerate Schedule Model too. 2013-09-03 19:43:28 +00:00
WritingAnLLVMPass.rst fix RST reference in Writing an LLVM Pass 2013-10-30 17:09:32 +00:00
yaml2obj.rst Fix common typos in the docs. 2013-10-29 17:53:27 +00:00
YamlIO.rst Reverting my r193344 checkin due to build breakage. 2013-10-24 14:52:56 +00:00

LLVM Documentation
==================

LLVM's documentation is written in reStructuredText, a lightweight
plaintext markup language (file extension `.rst`). While the
reStructuredText documentation should be quite readable in source form, it
is mostly meant to be processed by the Sphinx documentation generation
system to create HTML pages which are hosted on <http://llvm.org/docs/> and
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

The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `_build/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
very fast and includes examples of the most important reStructuredText
markup syntax.

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/`.

    cd docs/
    make -f Makefile.sphinx man
    man -l _build/man/FileCheck.1

The correspondence between .rst files and man pages is
`docs/CommandGuide/Foo.rst` <-> `_build/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`.