Commit Graph

39 Commits

Author SHA1 Message Date
Logan Chien
f7a833adfd [docs] Update the doxygen configuration file.
Update the doxygen configuration file and Makefile build rules
to provide better output (simply use the default stylesheet and template
from the Doxygen distribution.)

This CL has upgrade doxygen.cfg.in to Doxygen 1.8.6.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@232064 91177308-0d34-0410-b5e6-96231b3b80d8
2015-03-12 17:26:27 +00:00
Logan Chien
4c841fd7f4 [autoconf] Refine doxygen document options.
This CL adds --enable-doxygen-search to enable doxygen search engine
and --enable-doxygen-qt-help to enable the Qt help file generation.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@232062 91177308-0d34-0410-b5e6-96231b3b80d8
2015-03-12 17:25:01 +00:00
Peter Zotov
fc21e4b4a8 [OCaml] Generate documentation again with autoconf buildsystem.
Patch by Evangelos Foutras:

r220899 started using ocamlfind to build the OCaml bindings but
docs/Makefile still contains references to the OCAMLDOC macro which
is no longer being defined. The result is that OCaml documentation
isn't generated/installed.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@230850 91177308-0d34-0410-b5e6-96231b3b80d8
2015-02-28 13:48:23 +00:00
Peter Zotov
8bc1b3c341 [OCaml] PR14083, PR9606: Only pick *.odoc files from current build target.
When several build targets, e.g. Debug+Asserts and Release+Asserts
are present, ocamldoc complains of duplicate interfaces.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@220831 91177308-0d34-0410-b5e6-96231b3b80d8
2014-10-28 22:45:25 +00:00
David Majnemer
ecfa16cc21 docs: Remove incompatibility with Solaris shell
There doesn't seem to be a need in checking if a directory exists if we
will just rm -rf it once we affirm that it does.  Instead, just blindly
try to delete it.

This fixes PR17541.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@192679 91177308-0d34-0410-b5e6-96231b3b80d8
2013-10-15 08:30:07 +00:00
Michael Gottesman
4cff093bd6 [doxygen] Use correct variable names for external variable configuration and make EXTRA_SEARCH_MAPPINGS a "dumb" variable.
I do not think the massaging that I was doing for EXTRA_SEARCH_MAPPINGS was
truly necessary.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@189522 91177308-0d34-0410-b5e6-96231b3b80d8
2013-08-28 21:55:26 +00:00
Michael Gottesman
1800b662a0 [doxygen] Added support for doxygen external search.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@189507 91177308-0d34-0410-b5e6-96231b3b80d8
2013-08-28 20:28:35 +00:00
Daniel Dunbar
a5d2435409 [docs] Remove POD based man page docs (and build system support).
- Currently this leaves us with less build system support (e.g., installing man pages) for the docs than is desired. I'm working on fixing this, but it may take a while. If someone finds this particularly egregious let me know and I will prioritize it.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@156389 91177308-0d34-0410-b5e6-96231b3b80d8
2012-05-08 17:48:21 +00:00
Daniel Dunbar
f2c696f016 [docs] Include the Kaleidescope tutorial in the Sphinx docs build.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@156032 91177308-0d34-0410-b5e6-96231b3b80d8
2012-05-02 22:46:36 +00:00
Benjamin Kramer
34c53f3ac9 LLVM docs no longer contain images, don't try to install them.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@155206 91177308-0d34-0410-b5e6-96231b3b80d8
2012-04-20 17:14:26 +00:00
Erick Tryzelaar
ff3dbde905 Don't run ocamldoc if it's not installed
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@125203 91177308-0d34-0410-b5e6-96231b3b80d8
2011-02-09 18:32:04 +00:00
Eric Christopher
031d30781a Use GZIPBIN instead of GZIP. Apparently gzip uses GZIP as an environment
variable for args you want to default pass to gzip.

Patch based on one by asau@inbox.ru.

Fixes PR8758.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121449 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-10 01:31:51 +00:00
mike-m
e2c3a49c80 Revert r103213. It broke several sections of live website.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103219 91177308-0d34-0410-b5e6-96231b3b80d8
2010-05-07 00:28:04 +00:00
mike-m
68cb31901c Overhauled llvm/clang docs builds. Closes PR6613.
NOTE: 2nd part changeset for cfe trunk to follow.

*** PRE-PATCH ISSUES ADDRESSED

- clang api docs fail build from objdir
- clang/llvm api docs collide in install PREFIX/
- clang/llvm main docs collide in install
- clang/llvm main docs have full of hard coded destination
  assumptions and make use of absolute root in static html files;
  namely CommandGuide tools hard codes a website destination
  for cross references and some html cross references assume
  website root paths

*** IMPROVEMENTS

- bumped Doxygen from 1.4.x -> 1.6.3
- splits llvm/clang docs into 'main' and 'api' (doxygen) build trees
- provide consistent, reliable doc builds for both main+api docs
- support buid vs. install vs. website intentions
- support objdir builds
- document targets with 'make help'
- correct clean and uninstall operations
- use recursive dir delete only where absolutely necessary
- added call function fn.RMRF which safeguards against botched 'rm -rf';
  if any target (or any variable is evaluated) which attempts
  to remove any dirs which match a hard-coded 'safelist', a verbose
  error will be printed and make will error-stop.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103213 91177308-0d34-0410-b5e6-96231b3b80d8
2010-05-06 23:45:43 +00:00
Erick Tryzelaar
d4076cfc83 Rewrite makefiles to explicitly reference DESTDIR to fix bug 3153.
We need this so can not bake DESTDIR into the O'Caml symlinks.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@97743 91177308-0d34-0410-b5e6-96231b3b80d8
2010-03-04 20:56:19 +00:00
Bob Wilson
d934b63ed1 Rearrange rules to add missing dependency and allow parallel makes.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@91352 91177308-0d34-0410-b5e6-96231b3b80d8
2009-12-14 22:44:22 +00:00
Gordon Henriksen
56a7c88cc5 Add a unified 'generated documentation' target so the web site script has a consistent target to use.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@48985 91177308-0d34-0410-b5e6-96231b3b80d8
2008-03-31 17:27:57 +00:00
Erick Tryzelaar
4f678c3692 Tweak build system to allow for installing the tutorial and uninstalling the docs.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@48968 91177308-0d34-0410-b5e6-96231b3b80d8
2008-03-30 20:32:18 +00:00
Gordon Henriksen
b047766963 Adding ocamldoc generation.
Patch by Erick Tryzelaar.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@48147 91177308-0d34-0410-b5e6-96231b3b80d8
2008-03-10 15:49:16 +00:00
Chris Lattner
4d44d7a2dc Always for PACKAGEVERSION to 'mainline' for teh llvm web page.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@46425 91177308-0d34-0410-b5e6-96231b3b80d8
2008-01-27 23:43:26 +00:00
Chris Lattner
57360d1f1c remove attributions from the rest of the llvm makefiles.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@45416 91177308-0d34-0410-b5e6-96231b3b80d8
2007-12-29 20:11:13 +00:00
Reid Spencer
669ed45029 Subversionify the documentation.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@38442 91177308-0d34-0410-b5e6-96231b3b80d8
2007-07-09 08:04:31 +00:00
Reid Spencer
cf4c42cde2 Get the version number right, finally.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@37905 91177308-0d34-0410-b5e6-96231b3b80d8
2007-07-05 10:00:19 +00:00
Tanya Lattner
10c66c3b84 We really should not have this version number in SO many makefiles. This should also probably change to svn instead of cvs, but leaving it for now.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@37855 91177308-0d34-0410-b5e6-96231b3b80d8
2007-07-03 18:11:20 +00:00
Tanya Lattner
b747fd221d Fixing doxygen.cfg target. I'm not a makefile expert, so hopefully this correct.Tested doxygen generation on zion.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@35390 91177308-0d34-0410-b5e6-96231b3b80d8
2007-03-27 23:19:39 +00:00
Reid Spencer
0b57a76bc8 For PR1276:
Allow doxygen documentation to be rebuilt manually with "make regendoc"
separately from "make install".

Patch by Scott Michel.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@35378 91177308-0d34-0410-b5e6-96231b3b80d8
2007-03-27 06:06:15 +00:00
Reid Spencer
12cabda941 Get the version number for the LLVM from the autoconf/configure.ac file
when building the documentation for the web site.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@34894 91177308-0d34-0410-b5e6-96231b3b80d8
2007-03-04 00:45:50 +00:00
Chris Lattner
9e4692c617 The web site uses this
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@29006 91177308-0d34-0410-b5e6-96231b3b80d8
2006-07-06 00:36:52 +00:00
Chris Lattner
889bc47677 copy the doxygen tarball into the HTML directory after building it
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@24529 91177308-0d34-0410-b5e6-96231b3b80d8
2005-11-30 06:31:28 +00:00
Reid Spencer
d5de2c8ede Adjust the dependencies and generate the output to docs/userloc.html so
that it can properly link to the CSS stylesheet and images.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@22092 91177308-0d34-0410-b5e6-96231b3b80d8
2005-05-16 18:29:13 +00:00
Reid Spencer
ee6fcf2915 Add the ability to generate the User LOC page via the userloc.pl script.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@22090 91177308-0d34-0410-b5e6-96231b3b80d8
2005-05-16 18:12:58 +00:00
Reid Spencer
29fbdd705a For PR528:
Use the DataInstall and MKDIR macros instead of using $(INSTALL) directly


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@20318 91177308-0d34-0410-b5e6-96231b3b80d8
2005-02-24 21:28:08 +00:00
Reid Spencer
bdf6a39d1c Rename BUILD_* to PROJ_*
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@19592 91177308-0d34-0410-b5e6-96231b3b80d8
2005-01-16 02:21:29 +00:00
Reid Spencer
5a069f5a7e Make the construction of doxygen documentation a repeatable process
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@19469 91177308-0d34-0410-b5e6-96231b3b80d8
2005-01-11 06:26:27 +00:00
Reid Spencer
ca5fc7bf63 * Make this makefile compliant with LLVM makefile standards
* Implement optional doxygen doc generation
* Implement HTML and doxygen installation


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@18324 91177308-0d34-0410-b5e6-96231b3b80d8
2004-11-29 04:47:35 +00:00
John Criswell
d8846c19bd Added LLVM copyright notice.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@9319 91177308-0d34-0410-b5e6-96231b3b80d8
2003-10-21 14:33:46 +00:00
Chris Lattner
6d4d3e9641 Don't hardcode path to doxygen
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@3948 91177308-0d34-0410-b5e6-96231b3b80d8
2002-09-26 16:38:42 +00:00
Chris Lattner
b9a827ce63 Add rule to build tar.gz file.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@1592 91177308-0d34-0410-b5e6-96231b3b80d8
2002-01-30 21:20:23 +00:00
Chris Lattner
3785a662c2 Checkin support for building doxygen stuff
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@1586 91177308-0d34-0410-b5e6-96231b3b80d8
2002-01-26 21:16:41 +00:00