llvm-6502/docs
Thomas Schwinge 7f5f06b818 Correct spelling of Git.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@178254 91177308-0d34-0410-b5e6-96231b3b80d8
2013-03-28 18:06:20 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Update documentation of llvm-link to reflect recent cleanups. 2013-03-19 16:04:19 +00:00
HistoricalNotes
TableGen Allow TableGen DAG arguments to be just a name. 2013-03-24 19:36:51 +00:00
tutorial [docs] Remove explicit authorship. 2013-03-11 16:25:16 +00:00
AliasAnalysis.rst
Atomics.rst
BitCodeFormat.rst
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst Correct spelling of Git. 2013-03-28 18:06:20 +00:00
CodeGenerator.rst Extend TableGen instruction selection matcher to improve handling 2013-03-19 19:51:09 +00:00
CodingStandards.rst
CommandLine.rst
CompilerWriterInfo.rst [docs] Remove explicit authorship. 2013-03-11 16:25:16 +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
FAQ.rst
GarbageCollection.rst
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst Correct spelling of Git. 2013-03-28 18:06:20 +00:00
GettingStartedVS.rst
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst ARM build docs easier for copy&paste 2013-02-25 18:25:58 +00:00
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst [docs] Discuss a potential bug to be aware of. 2013-03-16 16:58:20 +00:00
HowToSubmitABug.rst
HowToUseAttributes.rst Documentation: HowToUseAttributes: formatting (use monospaced font) 2013-02-12 18:26:08 +00:00
HowToUseInstrMappings.rst
index.rst Adding a HowTo for Attributes. 2013-02-12 11:45:22 +00:00
LangRef.rst Added documentation to LangRef for the intrinsic llvm.ptr.annotation.* which for some reason was never written. 2013-03-26 00:34:27 +00:00
Lexicon.rst [docs] PR15254: Add "AST" to the lexicon. 2013-02-13 21:17:20 +00:00
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst
LLVMBuild.txt
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst
MarkedUpDisassembly.rst
Packaging.rst
Passes.rst [docs] Remove explicit authorship. 2013-03-11 16:25:16 +00:00
Phabricator.rst Update phab docs to clarify how to accept a change. 2013-02-13 09:07:18 +00:00
ProgrammersManual.rst [docs] Slight reword for precision. 2013-03-22 23:52:38 +00:00
Projects.rst
re_format.7
README.txt [docs] Discuss manpage output. 2013-02-27 18:48:42 +00:00
ReleaseNotes.rst Mention the new TableGen pattern format in the release notes. 2013-03-25 00:36:53 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst Formatting fixups. 2013-03-19 23:10:26 +00:00
SphinxQuickstartTemplate.rst [docs] Provide pointer for building Sphinx docs. 2013-02-27 18:33:21 +00:00
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst fix small doc typo 2013-03-22 16:09:06 +00:00
TestSuiteMakefileGuide.rst
Vectorizers.rst Brag about function call vectorization in the docs. 2013-02-28 19:33:46 +00:00
WritingAnLLVMBackend.rst Give Sparc instruction patterns direct types instead of register classes. 2013-03-24 00:56:20 +00:00
WritingAnLLVMPass.rst
yaml2obj.rst
YamlIO.rst Spelling corrections 2013-02-18 02:44:09 +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`.