maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
140,037 Commits 23 Branches 0 Tags 2.2 GiB
Commit Graph

15 Commits

Author SHA1 Message Date
Sean Silva d2a98e6dbb docs: Decrease toctree depth on landing page. 
Having the table of contents there was making it hard to easily see at a
glance all the docs we have.

llvm-svn: 171376
 2013-01-02 12:39:50 +00:00
Sean Silva ff15b34dda docs: Sphinx conversion is "done" 
llvm-svn: 171375
 2013-01-02 12:39:02 +00:00
Dmitri Gribenko dd20f2c3eb Documentation: add MemorySanitizer to the toctree 
llvm-svn: 171003
 2012-12-23 18:35:58 +00:00
Sean Silva fe25144e68 docs: Convert ReleaseNotes to reST. 
This is the last of the "regular" documents to convert to reST, and so
I'm declaring the initial clang reST conversion "done".

However,

- There are some documents in clang/www/ which probably should
  be migrated into clang/docs/, such as www/OpenProjects.html

  The primary thing blocking me from doing this right now is not knowing
  how to set up a redirect so that the old URL's continue to work.

- LibASTMatchersReference.html is not reST. This page is auto-generated
  by clang/docs/tools/dump_ast_matchers.py from the source and has some
  collapse/expand logic that isn't expressible directly with Sphinx, so
  just converting it to reST is not really a good strategy.

  Manuel Klimek and I discussed this and the general agreed-upon
  direction is making that page data-driven so that it, say, pulls in an
  auto-generated blob of JSON which describes the matchers and builds up
  the "matcher reference" part of the page with a small amount of JS.

- There are some rogue .txt files hanging around.

Also, I dropped the little dragon logo at the top because Sphinx was
warning about an external image reference (not sure why, but meh, I
didn't want to fight it). If anything, we would want such a logo
integrated into the site's overall theme, rather than hardcoded here.

llvm-svn: 170994
 2012-12-23 01:19:35 +00:00
Sean Silva 426914a549 docs: Convert ObjectiveCLiterals to reST. 
Sphinx's syntax highlighter doesn't recognize the new literals, so the
syntax highlighting is pretty pathetic.

llvm-svn: 170814
 2012-12-21 00:17:02 +00:00
Sean Silva 2ff89eb835 docs: fix Sphinx toctree warning. 
llvm-svn: 170813
 2012-12-21 00:16:58 +00:00
Sean Silva 5f25c50e91 docs: Convert DriverInternals to reST. 
llvm-svn: 170812
 2012-12-21 00:16:53 +00:00
Dmitri Gribenko d9d26072d6 Documentation: convert InternalsManual.html to reST 
Patch by Anastasi Voitova with with small fixes by me.

llvm-svn: 170275
 2012-12-15 20:41:17 +00:00
Jordan Rose ba8307d2e5 Remove old description of analyzer internals from public docs. 
The file still exists in docs/analyzer/, but it won't be linked to from
clang.llvm.org or processed as part of the default Sphinx doc-build.
RegionStore has changed a lot from what Ted and Zhongxing describe here!

llvm-svn: 170260
 2012-12-15 00:36:53 +00:00
Dmitri Gribenko 795774018e Documentation: add AutomaticReferenceCounting.rst to the toctree 
llvm-svn: 170133
 2012-12-13 16:06:00 +00:00
Sean Silva bf9b4cd596 docs: More reST conversion. 
Sorry for the large commit, but it is much faster to convert in batches.

llvm-svn: 170067
 2012-12-13 01:10:46 +00:00
Sean Silva 709c44d1f1 docs: Convert some docs to reST. 
Converts:
    LanguageExtensions
    LibASTMatchers
    LibTooling
    PCHInternals
    ThreadSanitizer
    Tooling

Patch by Mykhailo Pustovit!
(with minor edits by Dmitri Gribenko and Sean Silva)

llvm-svn: 170048
 2012-12-12 23:44:55 +00:00
Daniel Dunbar e50a92f754 docs: Another test commit (sphinx autoupdating). 
llvm-svn: 170047
 2012-12-12 23:35:03 +00:00
Daniel Dunbar e6daf69f8b docs: Test commit (sphinx autoupdating). 
llvm-svn: 170046
 2012-12-12 23:33:24 +00:00
Sean Silva 99b51c48cc docs: Initial Sphinx setup for Clang. 
I don't think this will be visible just yet on <clang.llvm.org/docs/>
since I don't think that the necessary server-side setup has taken
place.

Don't shoot me over the theme. I don't want to duplicate LLVM's theme
into the clang repo at the moment, so I just used one of Sphinx's
default themes.

llvm-svn: 170042
 2012-12-12 23:02:30 +00:00