Skip to content
  1. Dec 09, 2012
  2. Dec 07, 2012
    • Sean Silva's avatar
      docs: Convert LangRef to reST. · b084af41
      Sean Silva authored
      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
      b084af41
Loading