llvm-project/llvm/docs
Sanjoy Das 968d70ffda Fix the docs build
(and add a bit of formatting.)

llvm-svn: 294347
2017-02-07 20:36:03 +00:00
..
CommandGuide [llvm-cov] Don't show function summaries when filtering by filename (fixes PR31395) 2017-02-05 20:11:08 +00:00
Frontend
HistoricalNotes
PDB Add documentation for the PDB Module Info stream. 2016-11-29 22:14:56 +00:00
Proposals fix some typos in the doc 2017-01-14 11:37:01 +00:00
TableGen [Docs][TableGen] Remove reference to tablegen supporting octal integers. It doesn't and hasn't for at least 9 years. 2016-11-18 02:28:50 +00:00
_ocamldoc
_static Fix some typos in the doc 2016-08-28 20:29:18 +00:00
_templates
_themes/llvm-theme
tutorial Use print() instead of dump() in code 2017-01-28 02:47:46 +00:00
AMDGPUUsage.rst fix some typos in the doc 2017-01-14 11:37:01 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
AdvancedBuilds.rst Fixing autocorrect changing cmake->make 2016-03-18 22:11:51 +00:00
AliasAnalysis.rst [Docs] Add initial MemorySSA documentation. 2016-08-17 00:17:29 +00:00
Atomics.rst fix some various typos in the doc 2016-07-02 19:28:40 +00:00
BigEndianNEON.rst
BitCodeFormat.rst [docs] Update some obsolete information in BitCodeFormat docs. 2016-10-14 16:23:09 +00:00
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst This code block breaks the docs build (http://lab.llvm.org:8011/builders/llvm-sphinx-docs/builds/11925/steps/docs-llvm-html/logs/stdio). Setting the code highlighting to none instead of llvm. 2016-07-19 23:50:11 +00:00
Bugpoint.rst
CMake.rst [docs] Point to upstream Sphinx install instructions. 2017-01-22 03:47:49 +00:00
CMakeLists.txt [cmake] Support overriding remaining HTML doc install directories 2016-09-27 19:52:29 +00:00
CMakePrimer.rst [docs] fix cmake code-block warning 2016-07-20 09:47:09 +00:00
CodeGenerator.rst [Support/ELF/AMDGPU] Add 32-bit lo/hi got and pc relative relocations 2016-10-14 04:03:49 +00:00
CodeOfConduct.rst [Conduct] Refine what "rare cases" means wrt violations outside our spaces. 2016-07-06 19:32:41 +00:00
CodingStandards.rst Fix some remaining documentation references to MSVC 2013 2016-12-15 19:08:02 +00:00
CommandLine.rst Update CommandLine.rst getRegisteredOptions example 2016-11-07 02:43:01 +00:00
CompileCudaWithLLVM.rst [Docs] Update docs to indicate that CUDA compilation is supported on Windows. 2017-01-05 16:54:28 +00:00
CompilerWriterInfo.rst [docs] fix link to AMD manuals (PR30946) 2016-11-08 16:49:24 +00:00
Coroutines.rst Changing a code block to text because Sphinx does not like it on the builder (http://lab.llvm.org:8011/builders/llvm-sphinx-docs/builds/12517/steps/docs-llvm-html/logs/stdio) 2016-08-31 14:37:20 +00:00
CoverageMappingFormat.rst fix some typos in the doc 2017-01-14 11:37:01 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst wordsmith the "new targets" section a bit. 2016-08-17 22:17:03 +00:00
Dummy.html
ExceptionHandling.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst MC: Introduce the ABS8 symbol modifier. 2017-01-31 18:28:44 +00:00
FAQ.rst fix some typos in the doc 2016-07-28 09:28:58 +00:00
FaultMaps.rst Fix the docs build 2017-02-07 20:36:03 +00:00
GarbageCollection.rst Tidy up example of getting the pointer size. 2016-10-14 05:45:46 +00:00
GetElementPtr.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
GettingStarted.rst Fix GettingStarted doc so that the example build command for cmake LLVM_ENABLE_PROJECTS works on linux 2017-01-17 23:23:08 +00:00
GettingStartedVS.rst [doc] Remove explicit CMake version requirement for MSVC 2016-11-09 01:44:42 +00:00
GlobalISel.rst [AArch64][GlobalISel] Legalize narrow scalar ops again. 2017-01-23 21:10:05 +00:00
GoldPlugin.rst Revert 'Test commit as per developer policy' 2016-11-30 08:24:43 +00:00
HowToAddABuilder.rst [docs] Document the staging buildbot 2017-02-05 21:21:23 +00:00
HowToBuildOnARM.rst [Docs] Change ARM build info to CMake 2015-11-06 18:39:34 +00:00
HowToCrossCompileLLVM.rst [docs] Fix unexpected indentation in HowToCrossCompileLLVM.rst 2016-05-10 14:02:46 +00:00
HowToReleaseLLVM.rst Adding RELEASE_TESTERS.TXT 2016-07-21 16:46:44 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
InAlloca.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
LLVMBuild.rst Test commit. 2016-12-24 17:26:38 +00:00
LLVMBuild.txt
LangRef.rst This patch adds a ssa_copy intrinsic, as part of splitting up D29316. 2017-02-07 19:29:25 +00:00
Lexicon.rst [docs] Add PR to Lexicon 2016-10-06 16:39:22 +00:00
LibFuzzer.rst [libFuzzer] better link for trophies 2017-01-18 00:45:02 +00:00
LinkTimeOptimization.rst [docs] Typos and whitespace fixed in LTO docs. 2016-11-29 18:00:31 +00:00
MCJIT-creation.png
MCJIT-dyld-load.png
MCJIT-engine-builder.png
MCJIT-load-object.png
MCJIT-load.png
MCJIT-resolve-relocations.png
MCJITDesignAndImplementation.rst Fix several accidental DOS line endings in source files 2016-01-03 17:22:03 +00:00
MIRLangRef.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
Makefile.sphinx Bring back Makefile.sphinx 2016-03-23 00:30:57 +00:00
MarkedUpDisassembly.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
MemorySSA.rst Fix some typos in the doc 2016-08-28 20:29:18 +00:00
MergeFunctions.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
NVPTXUsage.rst Update NVVMReflect usage doc to new idiom for adding target-specific early passes. 2017-01-27 19:44:24 +00:00
OptBisect.rst Adding document describing the use of the -opt-bisect-limit option. 2016-08-26 23:11:48 +00:00
Packaging.rst
Passes.rst Remove the ScalarReplAggregates pass 2016-06-15 00:19:09 +00:00
Phabricator.rst [doc] Fix minor grammatical error in Phabricator.rst 2017-01-05 13:08:14 +00:00
ProgrammersManual.rst fix some typos in the doc 2017-01-14 11:37:01 +00:00
Projects.rst
README.txt [docs] Update the docs to describe how to build the docs with cmake 2016-02-07 15:42:12 +00:00
ReleaseNotes.rst Clear the release notes for 5.0.0 2017-01-12 21:50:22 +00:00
ReleaseProcess.rst [OPENMP] Make -fopenmp to turn on OpenMP support by default. 2015-12-10 05:45:58 +00:00
ReportingGuide.rst fix some various typos in the doc 2016-07-02 19:28:40 +00:00
ScudoHardenedAllocator.rst [scudo] Documentation update for Scudo, from https://reviews.llvm.org/D23332 2016-08-09 23:57:04 +00:00
SegmentedStacks.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
SourceLevelDebugging.rst [docs] Fix some typos. NFC. 2016-11-01 23:55:50 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst [Stackmap] Added callsite counts to emitted function information. 2016-09-14 20:22:03 +00:00
Statepoints.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
SystemLibrary.rst
TableGenFundamentals.rst
TestSuiteMakefileGuide.rst Fix the docs I broke 2016-03-11 23:31:02 +00:00
TestingGuide.rst Reinstate "r292904 - [lit] Allow boolean expressions in REQUIRES and XFAIL 2017-01-25 02:26:03 +00:00
TypeMetadata.rst IR: New representation for CFI and virtual call optimization pass metadata. 2016-06-24 21:21:32 +00:00
Vectorizers.rst
WritingAnLLVMBackend.rst fix some typos in the doc 2017-01-14 11:37:01 +00:00
WritingAnLLVMPass.rst [docs] Make WritingAnLLVMPass.rst up-to-date with current state of things 2016-09-27 12:07:21 +00:00
XRay.rst [XRay][docs] Define requirements on installed log handlers. 2016-11-16 02:18:23 +00:00
YamlIO.rst fix some typos in the doc 2017-01-14 11:37:01 +00:00
conf.py Bump trunk version to 5.0.0svn 2017-01-12 21:22:36 +00:00
doxygen-mainpage.dox [docs] Updated docs to work with Doxygen 1.8.11 2016-03-06 03:50:08 +00:00
doxygen.cfg.in [docs] Tell Doxygen to expand LLVM_ALIGNAS to nothing 2017-01-19 13:37:42 +00:00
gcc-loops.png
index.rst [PDB] Begin adding documentation for the PDB file format. 2016-11-10 19:24:21 +00:00
linpack-pc.png
make.bat
re_format.7
yaml2obj.rst

README.txt

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 <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
    make -j3 docs-llvm-html
    $BROWSER <build-dir>/docs//html/index.html

The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `<build-dir>/docs//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-dir>/docs/man/`.

    cd <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
    make -j3 docs-llvm-man
    man -l >build-dir>/docs/man/FileCheck.1

The correspondence between .rst files and man pages is
`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//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`.

Checking links
==============

The reachability of external links in the documentation can be checked by
running:

    cd docs/
    make -f Makefile.sphinx linkcheck