llvm/docs
2013-07-14 18:12:25 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Correct inaccurate statement in FileCheck docs. 2013-07-14 18:12:25 +00:00
HistoricalNotes
TableGen
tutorial [docs] Fix broken link. 2013-06-21 01:11:52 +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
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst Document LLVM_USE_SANITIZER CMake option 2013-07-09 10:56:13 +00:00
CodeGenerator.rst [SystemZ] Add disassembler support 2013-05-14 10:17:52 +00:00
CodingStandards.rst
CommandLine.rst CommandLine.rst: remove tiny bit of bad mark-up 2013-07-10 22:09:22 +00:00
CompilerWriterInfo.rst R600: Add ISA documents to the CompilerWriterInfo page 2013-07-12 18:14:40 +00:00
conf.py We're in 3.4 land now. 2013-05-07 20:31:28 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst
doxygen.cfg.in
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 MC: Implement COFF .linkonce directive 2013-07-06 12:13:10 +00:00
FAQ.rst
GarbageCollection.rst IR headers moved to llvm/IR some aeons ago, update documentation. 2013-07-08 19:59:35 +00:00
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst Fix documentation on the path to Bitcode reader/writer 2013-06-11 18:09:21 +00:00
GettingStartedVS.rst Updating the getting started guide for Visual Studio users. Specifically, pointing out that you have to pass additional parameters to llvm-lit and explicitly specify python on the command line. 2013-05-01 19:13:50 +00:00
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToReleaseLLVM.rst Typo 2013-05-28 11:28:37 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
index.rst Linking ReleaseProcess doc with the world 2013-05-28 10:32:55 +00:00
LangRef.rst Fix language. 2013-07-06 01:04:47 +00:00
Lexicon.rst
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst
LLVMBuild.txt
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst
MarkedUpDisassembly.rst
NVPTXUsage.rst
Packaging.rst
Passes.rst docs/Passes: fix some typos 2013-05-18 18:01:44 +00:00
Phabricator.rst
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 note for removing the simplify-libcalls pass. 2013-06-21 03:08:23 +00:00
ReleaseProcess.rst Update Release Process doc 2013-06-12 11:35:33 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst Debug Info: Update documentation to match recent (& not so recent) schema changes 2013-05-29 02:05:13 +00:00
SphinxQuickstartTemplate.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst Add platform specific tests doc 2013-07-03 20:56:33 +00:00
TestSuiteMakefileGuide.rst
Vectorizers.rst The SLP Vectorizer works across basic blocks. Update the docs. 2013-06-26 17:59:35 +00:00
WritingAnLLVMBackend.rst [docs] Amend confusing title 2013-07-01 20:45:12 +00:00
WritingAnLLVMPass.rst IR headers moved to llvm/IR some aeons ago, update documentation. 2013-07-08 19:59:35 +00:00
yaml2obj.rst
YamlIO.rst [docs] Replace non-existent LLVM_YAML_UNIQUE_TYPE() macro 2013-06-04 23:36:41 +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`.