mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-22 18:54:02 +01:00
c48f42e16c
Sorry for the massive commit, but I just wanted to knock this one down and it is really straightforward. There are still a couple trivial (i.e. not related to the content) things left to fix: - Use of raw HTML links where :doc:`...` and :ref:`...` could be used instead. If you are a newbie and want to help fix this it would make for some good bite-sized patches; more experienced developers should be focusing on adding new content (to this tutorial or elsewhere, but please _do not_ waste your time on formatting when there is such dire need for documentation (see docs/SphinxQuickstartTemplate.rst to get started writing)). - Highlighting of the kaleidoscope code blocks (currently left as bare `::`). I will be working on writing a custom Pygments highlighter for this, mostly as training for maintaining the `llvm` code-block's lexer in-tree. I want to do this because I am extremely unhappy with how it just "gives up" on the slightest deviation from the expected syntax and leaves the whole code-block un-highlighted. More generally I am looking at writing some Sphinx extensions and keeping them in-tree as well, to support common use cases that currently have no good solution (like "monospace text inside a link"). llvm-svn: 169343 |
||
|---|---|---|
| .. | ||
| _static | ||
| _templates | ||
| _themes/llvm-theme | ||
| CommandGuide | ||
| HistoricalNotes | ||
| tutorial | ||
| AliasAnalysis.rst | ||
| Atomics.rst | ||
| BitCodeFormat.rst | ||
| BranchWeightMetadata.rst | ||
| Bugpoint.rst | ||
| CMake.rst | ||
| CodeGenerator.rst | ||
| CodingStandards.rst | ||
| CommandLine.rst | ||
| CompilerWriterInfo.rst | ||
| conf.py | ||
| DebuggingJITedCode.rst | ||
| design_and_overview.rst | ||
| DeveloperPolicy.rst | ||
| development_process.rst | ||
| doxygen.cfg.in | ||
| doxygen.css | ||
| doxygen.footer | ||
| doxygen.header | ||
| doxygen.intro | ||
| ExceptionHandling.rst | ||
| ExtendedIntegerResults.txt | ||
| ExtendingLLVM.rst | ||
| FAQ.rst | ||
| GarbageCollection.html | ||
| GetElementPtr.rst | ||
| GettingStarted.rst | ||
| GettingStartedVS.rst | ||
| GoldPlugin.rst | ||
| HowToAddABuilder.rst | ||
| HowToBuildOnARM.rst | ||
| HowToReleaseLLVM.html | ||
| HowToSetUpLLVMStyleRTTI.rst | ||
| HowToSubmitABug.rst | ||
| HowToUseInstrMappings.rst | ||
| index.rst | ||
| LangRef.html | ||
| Lexicon.rst | ||
| LinkTimeOptimization.rst | ||
| LLVMBuild.rst | ||
| LLVMBuild.txt | ||
| mailing_lists.rst | ||
| make.bat | ||
| Makefile | ||
| Makefile.sphinx | ||
| MakefileGuide.rst | ||
| MarkedUpDisassembly.rst | ||
| Packaging.rst | ||
| Passes.html | ||
| Phabricator.rst | ||
| ProgrammersManual.rst | ||
| programming.rst | ||
| Projects.rst | ||
| re_format.7 | ||
| README.txt | ||
| ReleaseNotes.html | ||
| SegmentedStacks.rst | ||
| SourceLevelDebugging.rst | ||
| SphinxQuickstartTemplate.rst | ||
| subsystems.rst | ||
| SystemLibrary.rst | ||
| TableGenFundamentals.rst | ||
| TestingGuide.rst | ||
| TestSuiteMakefileGuide.rst | ||
| userguides.rst | ||
| WritingAnLLVMBackend.rst | ||
| 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.