llvm-6502/docs
Renato Golin 09b3900206 Add ARM to release instructions
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@197220 91177308-0d34-0410-b5e6-96231b3b80d8
2013-12-13 09:39:36 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Remove dangling documentation. llvm-prof was deleted a while ago. 2013-11-21 19:32:37 +00:00
HistoricalNotes
TableGen
tutorial [OCaml] (PR10016) Add a few missing line in OCamlLangImpl2.rst 2013-11-05 12:14:04 +00:00
AliasAnalysis.rst
Atomics.rst
BitCodeFormat.rst
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst CMake : optionaly enable LLVM to be compiled with -std=c++11 (default: off) 2013-11-26 10:33:53 +00:00
CMakeLists.txt
CodeGenerator.rst
CodingStandards.rst Correct word hyphenations 2013-12-05 05:44:44 +00:00
CommandLine.rst Correct word hyphenations 2013-12-05 05:44:44 +00:00
CompilerWriterInfo.rst [docs] Add link to 32-bit ARM ELF supplement. 2013-11-04 19:43:36 +00:00
conf.py
DebuggingJITedCode.rst
DeveloperPolicy.rst
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
Dummy.html
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst Support multiple COFF sections with the same name but different COMDAT. 2013-11-19 19:52:52 +00:00
FAQ.rst
GarbageCollection.rst
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst
GettingStartedVS.rst
GoldPlugin.rst Update the LTO GoldPlugin documentation 2013-12-02 07:15:33 +00:00
HowToAddABuilder.rst
HowToBuildOnARM.rst Adding some info about stability of ARM boards 2013-11-15 08:42:14 +00:00
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst Add ARM to release instructions 2013-12-13 09:39:36 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
index.rst
LangRef.rst Use "a" instead of "a0" in DataLayout. 2013-12-12 17:21:51 +00:00
Lexicon.rst
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst
LLVMBuild.txt
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst
MarkedUpDisassembly.rst
MCJIT-creation.png
MCJIT-dyld-load.png
MCJIT-engine-builder.png
MCJIT-load-object.png
MCJIT-load.png
MCJIT-resolve-relocations.png
MCJITDesignAndImplementation.rst
NVPTXUsage.rst [NVPTX] Fix type in usage doc 2013-11-15 16:08:49 +00:00
Packaging.rst
Passes.rst Typos. (Test commit.) 2013-11-14 18:47:23 +00:00
Phabricator.rst Update of the 'Code Review' page. The link is now called 'Create Diff' instead of 'Create Revision' 2013-11-11 14:27:56 +00:00
ProgrammersManual.rst Typos. (Test commit.) 2013-11-14 18:47:23 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst Update to reflect the next release. 2013-11-20 10:10:50 +00:00
ReleaseProcess.rst
SegmentedStacks.rst
SourceLevelDebugging.rst Correct word hyphenations 2013-12-05 05:44:44 +00:00
SphinxQuickstartTemplate.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst
TestSuiteMakefileGuide.rst
Vectorizers.rst
WritingAnLLVMBackend.rst Add a RequireStructuredCFG Field to TargetMachine. 2013-12-07 01:49:19 +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 YAML I/O add support for validate() 2013-11-21 00:28:07 +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`.