[cfe-dev] [RFC] Tutorial for Clang Analyzer Plugins

[Jordan Rose]

Hi, Sean. Anna and I discussed this a bit and we decided that what's in docs/analyzer/ really shouldn't appear on the analyzer website at all. It's internals documentation that is only relevant to people working on the static analyzer, and we don't yet know how we want to expose that on the site.

What does seem interesting is transitioning the entire analyzer site over to Sphinx, for increasing consistency among the LLVM projects. It's the pages people actually use that benefit most from transitioning to Sphinx, rather than random docs. Then there's no reason to have a docs/ subdirectory there, either.

We were then wondering why the same isn't happening for LLVM and Clang (and LLDB?). Transitioning the docs is great, but it's very jarring to have half of each site in Sphinx and half in HTML…and all with different themes. I think we'd prefer that the analyzer site not transition to Sphinx at all unless we can do the entire site at once.

Ted may want to chime in here too.
Jordan


On Jan 5, 2013, at 12:34 , Sean Silva <silvas at purdue.edu> wrote:

> Hi ddunbar, in transitioning the analyzer to Sphinx, I'm going to need
> some setup on the llvm.org server as with the other Sphinx
> transitions. As background, clang/docs/analyzer is excluded from the
> Sphinx build in clang/docs/, and has its own self-contained Sphinx
> build.
> 
> So what is needed is to run `make` inside `clang/docs/analyzer/` (no
> `-f Makefile.sphinx` since there was no conflicting Makefile in this
> directory), then copy `clang/docs/analyzer/_build/html/` to appear at
> <http://clang-analyzer.llvm.org/docs/>.
> 
> Thanks,
> 
> -- Sean Silva
> 
> On Wed, Jan 2, 2013 at 6:19 PM, Sean Silva <silvas at purdue.edu> wrote:
>> On Wed, Jan 2, 2013 at 2:56 PM, Anna Zaks <ganna at apple.com> wrote:
>>> Would be great to have the analyzer documentation converted, but I don't
>>> know if anyone has committed to do the work.
>> 
>> In r171424 and r171425 I have set up a basic Sphinx setup for the
>> analyzer in docs/analyzer/ (segregated from the rest of clang's docs).
>> There is no server-side support though so it doesn't currently affect
>> the website.
>> 
>> -- Sean Silva

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-dev/attachments/20130107/6e80ff24/attachment.html>