From ccb8019fba57020198f829ce8183878e6e0dcfc8 Mon Sep 17 00:00:00 2001 From: Sean Silva Date: Wed, 2 Jan 2013 02:31:51 +0000 Subject: [PATCH] docs: update docs/README.txt and make it useful. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@171353 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/README.txt | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/README.txt b/docs/README.txt index 5ddd599d8a7..fcc1badaf69 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -1,12 +1,24 @@ LLVM Documentation ================== -The LLVM documentation is currently written in two formats: +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 meant to be processed by the Sphinx documentation generation system to +create HTML pages which are hosted on and updated +after every commit. - * Plain HTML documentation. +If you instead would like to generate and view the HTML locally, install +Sphinx and then do: - * reStructured Text documentation using the Sphinx documentation generator. It - is currently tested with Sphinx 1.1.3. + cd docs/ + make -f Makefile.sphinx + $BROWSER _build/html/index.html - For more information, see the "Sphinx Introduction for LLVM Developers" - document. +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. -- 2.34.1