summaryrefslogtreecommitdiff
path: root/docs/README.txt
diff options
context:
space:
mode:
authorDaniel Dunbar <daniel@zuster.org>2012-04-19 16:31:19 +0000
committerDaniel Dunbar <daniel@zuster.org>2012-04-19 16:31:19 +0000
commit75083ebc09a3dd47099e3912ac090dbc907f3eaf (patch)
tree20edebe81dacd338dd222b40866b9102424693f4 /docs/README.txt
parent90275ea2ee7c7a960a3567926140b26a526b0aa1 (diff)
downloadllvm-75083ebc09a3dd47099e3912ac090dbc907f3eaf.tar.gz
llvm-75083ebc09a3dd47099e3912ac090dbc907f3eaf.tar.bz2
llvm-75083ebc09a3dd47099e3912ac090dbc907f3eaf.tar.xz
[docs] Stub out structure for Sphinx-based docs.
- Work in progress, this is just the basic structure. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@155132 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/README.txt')
-rw-r--r--docs/README.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/README.txt b/docs/README.txt
new file mode 100644
index 0000000000..2fbbf98740
--- /dev/null
+++ b/docs/README.txt
@@ -0,0 +1,12 @@
+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.