> Does anyone know if there is any limitation on moving the sphinx docs to 
the build tree?

  I would really prefer that the doxygen docs not be in the build tree in the 
first place, since that makes them dependent on the build system. For now, keep 
all build products for the documentation inside the `_build` directory that 
Sphinx uses. If we want to tie in the build system, it will need a concerted 
effort to be done right (e.g. work with both build systems, install things in 
the right places pages (which will probably need input from package 
maintainers), actually build the man pages, work cleanly across 
LLVM/Clang/clang-tools-extra, etc.).

  Basically, <http://clang.llvm.org/extra/> hosts the files that are in the 
`docs/_build/html/` directory after executing `make html` (or maybe just 
`make`, which defaults to `make html` I think; ddunbar would know the exact 
details). So basically `docs/_build/html/foo.html` becomes 
<http://clang.llvm.org/extra/foo.html>.

  I would recommend mimicking 
<https://github.com/chisophugis/klang/tree/master/docs> as closely as possible. 
What it does is to tell doxygen to generate the HTML output in 
`docs/_build/html/doxygen/`. You can diff the Doxyfile there against the 
default one to see what changes I made to make that happen. In particular, 
<https://github.com/chisophugis/klang/blob/master/docs/Doxyfile#L55> and 
<https://github.com/chisophugis/klang/blob/master/docs/Doxyfile#L898>.

http://llvm-reviews.chandlerc.com/D451
_______________________________________________
cfe-commits mailing list
[email protected]
http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits

Reply via email to