From b084af416a85e2a6720791a812d6ec069db9cb3e Mon Sep 17 00:00:00 2001 From: Sean Silva Date: Fri, 7 Dec 2012 10:36:55 +0000 Subject: docs: Convert LangRef to reST. NOTE: If you have any patches in the works that modify LangRef, you will need to rewrite the changes to LangRef.html to their equivalents in LangRef.rst. If you need assistance feel free to contact me. Since LangRef is mission-critical for the project and "normative", I have taken extra care to ensure that no content was lost or altered in the conversion. The content was converted with a tool called `pandoc`, so there is no chance for a human error like accidentally forgetting a sentence or whatever. After the initial conversion by `pandoc`, only changes to the markup were done. This is just the most literal conversion of the HTML document as possible. It might be worth exploring some way to chop up this massive document into separate pages, e.g. something like `docs/LangRef/Instructions.rst`, `docs/LangRef/Intrinsics.rst`, etc. with `docs/LangRef.rst` being an "intro/navigation page" of sorts. On the other hand, that loses the ability to {Ctrl,Cmd}-F for a given term right from your browser. IMO, I think our stylesheet needs some work because I find it hard to tell what level of nesting some of the headings are at (e.g. "is this a new section or is it a subsection?"). The issue is present on other pages, but the sheer size and deep section structure of LangRef really brings this issue out. If there are any web designers out there in the community it would be awesome if you tried to come up with something nicer. llvm-svn: 169596 --- llvm/docs/design_and_overview.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'llvm/docs/design_and_overview.rst') diff --git a/llvm/docs/design_and_overview.rst b/llvm/docs/design_and_overview.rst index ea684155e00..22e8125bb6d 100644 --- a/llvm/docs/design_and_overview.rst +++ b/llvm/docs/design_and_overview.rst @@ -6,9 +6,10 @@ LLVM Design & Overview .. toctree:: :hidden: + LangRef GetElementPtr -* `LLVM Language Reference Manual `_ +* :doc:`LangRef` Defines the LLVM intermediate representation. -- cgit v1.2.3