llvm-6502/docs
Dmitri Gribenko e17d858da8 Documentation: convert ReleaseNotes.html to reST.
Patch by Anthony Mykhailenko with small fixes by me.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169714 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-09 23:14:26 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Update FileCheck's documentation to mention recently added feature of 2012-12-01 22:03:57 +00:00
HistoricalNotes
tutorial docs: Sphinxify docs/tutorial/ 2012-12-05 00:26:32 +00:00
AliasAnalysis.rst
Atomics.rst
BitCodeFormat.rst Better 80cols... *sigh* 2012-11-20 18:14:15 +00:00
BranchWeightMetadata.rst Fixed some grammar and punctuation error. 2012-12-07 19:21:10 +00:00
Bugpoint.rst
CMake.rst
CodeGenerator.rst Documentation: convert ReleaseNotes.html to reST. 2012-12-09 23:14:26 +00:00
CodingStandards.rst Simplify the coding standards for #include ordering. The ordering is now 2012-12-02 11:53:27 +00:00
CommandLine.rst
CompilerWriterInfo.rst
conf.py Bump sphinx config to 3.3. 2012-11-17 22:12:59 +00:00
DebuggingJITedCode.rst
design_and_overview.rst docs: Convert LangRef to reST. 2012-12-07 10:36:55 +00:00
DeveloperPolicy.rst Documentation: convert ReleaseNotes.html to reST. 2012-12-09 23:14:26 +00:00
development_process.rst Convert HowToReleaseLLVM.html to reST 2012-12-07 16:42:48 +00:00
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
FAQ.rst
GarbageCollection.rst docs: Convert GarbageCollection.html to reST 2012-12-09 15:52:47 +00:00
GetElementPtr.rst Documentation: fix typos and formatting. 2012-12-06 21:12:35 +00:00
GettingStarted.rst docs: [CMake] Add Xcode to the list of project formats CMake can generate. 2012-11-27 23:34:28 +00:00
GettingStartedVS.rst
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToReleaseLLVM.rst Documentation: HowToReleaseLLVM.rst: remove trailing whitespace. 2012-12-09 15:33:26 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseInstrMappings.rst Fix typo. 2012-11-15 21:21:01 +00:00
index.rst
LangRef.rst So many people have touched this, it doesn't make sense to ascribe authorship anymore. 2012-12-09 16:55:39 +00:00
Lexicon.rst
LinkTimeOptimization.rst
LLVMBuild.rst docs: Sphinxify LLVMBuild documentation. 2012-11-20 03:13:53 +00:00
LLVMBuild.txt
mailing_lists.rst
make.bat
Makefile
Makefile.sphinx docs: Sphinxify docs/tutorial/ 2012-12-05 00:26:32 +00:00
MakefileGuide.rst docs: Sphinxify TestingGuide 2012-11-14 21:09:30 +00:00
MarkedUpDisassembly.rst
Packaging.rst
Passes.html Remove 'sretpromotion' pass from the documentation. This pass is long 2012-11-22 11:17:08 +00:00
Phabricator.rst
ProgrammersManual.rst docs: Fix broken link. 2012-12-04 03:45:27 +00:00
programming.rst docs: Convert ProgrammersManual to reST. 2012-12-04 03:20:08 +00:00
Projects.rst docs: Sphinxify TestingGuide 2012-11-14 21:09:30 +00:00
re_format.7
README.txt
ReleaseNotes.rst Documentation: convert ReleaseNotes.html to reST. 2012-12-09 23:14:26 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst Some grammar fixes 2012-11-28 00:27:25 +00:00
SphinxQuickstartTemplate.rst docs: Explain plain preformatted text 2012-12-05 04:07:33 +00:00
subsystems.rst docs: Convert GarbageCollection.html to reST 2012-12-09 15:52:47 +00:00
SystemLibrary.rst Documentation: improve formatting and remove unneeded empty lines. 2012-11-28 21:40:54 +00:00
TableGenFundamentals.rst Some sphinx-ing and consistency fixes 2012-11-20 19:37:58 +00:00
TestingGuide.rst Get rid of references to Tcl, DejagGNU, old test structure, discourage the use 2012-12-04 14:34:00 +00:00
TestSuiteMakefileGuide.rst docs: Sphinxify TestSuiteMakefileGuide 2012-11-14 23:11:10 +00:00
userguides.rst Documentation: convert ReleaseNotes.html to reST. 2012-12-09 23:14:26 +00:00
WritingAnLLVMBackend.rst Documentation: convert WritingAnLLVMBackend.html to reST 2012-12-01 12:13:48 +00:00
WritingAnLLVMPass.html
yaml2obj.rst

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

The LLVM documentation is currently written in two formats:

  * Plain HTML documentation.

  * reStructured Text documentation using the Sphinx documentation generator. It
    is currently tested with Sphinx 1.1.3. 

    For more information, see the "Sphinx Introduction for LLVM Developers"
    document.