diff mbox

[22/27] Documentation: top-level index.rst

Message ID 1414774977-25605-22-git-send-email-dmalcolm@redhat.com
State New
Headers show

Commit Message

David Malcolm Oct. 31, 2014, 5:02 p.m. UTC 
The top-level index.rst provides the high-level structure for the
rest of the docs (which will follow in the patches that follow).

gcc/jit/ChangeLog:
	* docs/index.rst: New.
---
 gcc/jit/docs/index.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 gcc/jit/docs/index.rst

Comments

Jeff Law Oct. 31, 2014, 9:21 p.m. UTC | #1 
On 10/31/14 11:02, David Malcolm wrote:
> The top-level index.rst provides the high-level structure for the
> rest of the docs (which will follow in the patches that follow).
>
> gcc/jit/ChangeLog:
> 	* docs/index.rst: New.
OK.
Jeff
> ---
diff mbox

Patch

diff --git a/gcc/jit/docs/index.rst b/gcc/jit/docs/index.rst
new file mode 100644
index 0000000..ed75e36
--- /dev/null
+++ b/gcc/jit/docs/index.rst
@@ -0,0 +1,50 @@ 
+.. Copyright (C) 2014 Free Software Foundation, Inc.
+   Originally contributed by David Malcolm <dmalcolm@redhat.com>
+
+   This is free software: you can redistribute it and/or modify it
+   under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful, but
+   WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see
+   <http://www.gnu.org/licenses/>.
+
+libgccjit
+=========
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   intro/index.rst
+   topics/index.rst
+   internals/index.rst
+
+This document describes `libgccjit <http://gcc.gnu.org/wiki/JIT>`_, an API
+for embedding GCC inside programs and libraries.
+
+Note that libgccjit is currently of "Alpha" quality;
+the APIs are not yet set in stone, and they shouldn't be used in
+production yet.
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. Some notes:
+
+   The Sphinx C domain appears to lack explicit support for enum values,
+   so I've been using :c:macro: for them.
+
+   See http://sphinx-doc.org/domains.html#the-c-domain