aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-20 16:04:48 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-20 16:04:48 +0000
commitab72c701f3028120985c4adad5c79b995a77b009 (patch)
tree1018c723ff54c173a9ba2becc9c1cb37dc178dc6
parent09f3a849a34f76830e7c9e33b76471819ff09491 (diff)
downloadpaludis-ab72c701f3028120985c4adad5c79b995a77b009.tar.gz
paludis-ab72c701f3028120985c4adad5c79b995a77b009.tar.xz
Make doc/api/cplusplus work
-rw-r--r--doc/api/Makefile.am35
-rw-r--r--doc/api/cplusplus/Makefile.am14
-rw-r--r--doc/api/cplusplus/doxygen.conf.in2
-rw-r--r--doc/api/index.html.part14
-rw-r--r--doc/api/toplinks.html.part.in84
-rw-r--r--doc/index.html.part.in10
6 files changed, 154 insertions, 5 deletions
diff --git a/doc/api/Makefile.am b/doc/api/Makefile.am
index 92a7f34..4c86158 100644
--- a/doc/api/Makefile.am
+++ b/doc/api/Makefile.am
@@ -1,8 +1,41 @@
SUBDIRS = cplusplus python ruby .
-CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda
+CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \
+ header.html.part \
+ toplinks.html.part \
+ footer.html.part \
+ index.html
+
+EXTRA_DIST = \
+ toplinks.html.part.in \
+ index.html.part
+
MAINTAINERCLEANFILES = Makefile.in
+paludisapihtmldir = $(htmldir)/api
+
+paludisapihtml_DATA = \
+ index.html
+
+index.html : header.html.part index.html.part footer.html.part
+ cat header.html.part index.html.part footer.html.part > $@
+
+header.html.part : $(srcdir)/../header.html.part.in toplinks.html.part
+ sed \
+ -e 's,###TOPURI###,../,g' \
+ -e '/###TOPLINKS###/r $(srcdir)/toplinks.html.part' \
+ -e 's,###TOPLINKS###,,g' \
+ < $(srcdir)/../header.html.part.in > header.html.part
+
+toplinks.html.part : $(srcdir)/toplinks.html.part.in
+ sed \
+ -e 's,###TOPURI###,../,g' \
+ < $(srcdir)/toplinks.html.part.in > toplinks.html.part
+
+footer.html.part : $(srcdir)/../footer.html.part.in
+ sed -e 's,###TOPURI###,./,g' < $(srcdir)/../footer.html.part.in > footer.html.part
+
+
built-sources : $(BUILT_SOURCES)
for s in `echo $(SUBDIRS) | tr -d .` ; do $(MAKE) -C $$s built-sources || exit 1 ; done
diff --git a/doc/api/cplusplus/Makefile.am b/doc/api/cplusplus/Makefile.am
index 547992c..ac0204f 100644
--- a/doc/api/cplusplus/Makefile.am
+++ b/doc/api/cplusplus/Makefile.am
@@ -21,15 +21,23 @@ doxygen_files = \
references.doxygen
EXTRA_DIST = doxygen.conf.in $(doxygen_files)
-CLEANFILES = *~ doxygen/* paludis.tag
+CLEANFILES = *~ cplusplus/* cplusplus paludis.tag
MAINTAINERCLEANFILES = Makefile.in doxygen.conf $(tagfiles)
if HAVE_DOXYGEN
-doxygen : doxygen.conf $(doxygen_files) $(tagfiles)
+all-local : cplusplus
+
+doxygen : cplusplus
+
+cplusplus : doxygen.conf $(doxygen_files) $(tagfiles)
doxygen doxygen.conf
+install-data-local :
+ mkdir -p $(DESTDIR)$(htmldir)/api
+ cp -R cplusplus/ $(DESTDIR)$(htmldir)/api/cplusplus
+
else
doxygen :
@@ -47,7 +55,7 @@ distcheck-deps-subdirs :
for s in `echo $(SUBDIRS) | tr -d .` ; do $(MAKE) -C $$s distcheck-deps || exit 1 ; done
clean-local :
- rm -fr doxygen/
+ rm -fr cplusplus/
htmldocs : htmldocs-subdirs
diff --git a/doc/api/cplusplus/doxygen.conf.in b/doc/api/cplusplus/doxygen.conf.in
index d5cfe2b..5436257 100644
--- a/doc/api/cplusplus/doxygen.conf.in
+++ b/doc/api/cplusplus/doxygen.conf.in
@@ -672,7 +672,7 @@ GENERATE_HTML = YES
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
-HTML_OUTPUT = doxygen
+HTML_OUTPUT = cplusplus
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
diff --git a/doc/api/index.html.part b/doc/api/index.html.part
new file mode 100644
index 0000000..f2d5d1c
--- /dev/null
+++ b/doc/api/index.html.part
@@ -0,0 +1,14 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>API</h1>
+
+<ul>
+ <li>The core library code is written in <a href="cplusplus/index.html">C++</a>.</li>
+ <li>
+ <p>Bindings are available for:</p>
+ <ul>
+ <li><a href="ruby/index.html">Ruby</a></li>
+ <li><a href="python/index.html">Python</a></li>
+ </ul>
+ </li>
+</ul>
diff --git a/doc/api/toplinks.html.part.in b/doc/api/toplinks.html.part.in
new file mode 100644
index 0000000..f6f121e
--- /dev/null
+++ b/doc/api/toplinks.html.part.in
@@ -0,0 +1,84 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<div class="topnavinner">
+ <table border="0" cellspacing="0">
+ <tr>
+ <td rowspan="7" class="logotab">
+ <a href="###TOPURI###/index.html" class="noarrow"><img style="border: 0px; padding-right: 50px;"
+ src="###TOPURI###paludis_270.png" alt="Paludis Logo"
+ /></a>
+ </td>
+
+ <td>
+ <a href="###TOPURI###/index.html">Introduction</a>
+ </td>
+
+ <td class="currentpage">
+ <a href="###TOPURI###api/cplusplus/index.html">C++ (core)</a>
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://paludis.pioto.org/trac/">Bugs, Requests, Support</a>
+ </td>
+
+ <td class="currentpage">
+ <a href="###TOPURI###/api/python/index.html">Python (bindings)</a>
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="###TOPURI###overview/index.html">Overview</a>
+ </td>
+
+ <td class="currentpage">
+ <a href="###TOPURI###api/ruby/index.html">Ruby (bindings)</a>
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="###TOPURI###faq/index.html">FAQ</a>
+ </td>
+
+ <td class="currentpage">
+ &nbsp;
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="###TOPURI###clients/index.html">Clients</a>
+ </td>
+
+ <td class="currentpage">
+ &nbsp;
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="###TOPURI###configuration/index.html">Configuration</a>
+ </td>
+
+ <td class="currentpage">
+ &nbsp;
+ </td>
+ </tr>
+
+ <tr>
+ <td class="currenttab">
+ <a href="###TOPURI###api/index.html">API</a>
+ </td>
+
+ <td class="currentpage">
+ &nbsp;
+ </td>
+ </tr>
+ </table>
+</div>
+
+
+
diff --git a/doc/index.html.part.in b/doc/index.html.part.in
index 78fb76c..f7c746c 100644
--- a/doc/index.html.part.in
+++ b/doc/index.html.part.in
@@ -86,4 +86,14 @@
<h2>API Documentation</h2>
+<ul>
+ <li>The core library code is written in <a href="api/cplusplus/index.html">C++</a>.</li>
+ <li>
+ <p>Bindings are available for:</p>
+ <ul>
+ <li><a href="api/ruby/index.html">Ruby</a></li>
+ <li><a href="api/python/index.html">Python</a></li>
+ </ul>
+ </li>
+</ul>