aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2011-11-21 02:00:42 +0000
committerDavid Robillard <d@drobilla.net>2011-11-21 02:00:42 +0000
commit27a265f350ca8f568b95bd3d94e62a62e91c05b7 (patch)
treec3d4816f767cca3894859934f2793d777606026f
parenteb43c8896480114b224755e824fae2e2f7485256 (diff)
downloadlv2-27a265f350ca8f568b95bd3d94e62a62e91c05b7.tar.xz
Run everything from the build directory and don't pollute the source directory.
-rw-r--r--Doxyfile58
-rw-r--r--doc/mainpage.dox13
-rwxr-xr-xgendoc.py17
3 files changed, 42 insertions, 46 deletions
diff --git a/Doxyfile b/Doxyfile
index af4c8f9..73b81b8 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NUMBER =
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = build/ns/doc
+OUTPUT_DIRECTORY = ns/doc
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -565,32 +565,32 @@ WARN_LOGFILE =
# with spaces.
INPUT = \
- doc/mainpage.dox \
- lv2/ns/ext/atom/atom-buffer.h \
- lv2/ns/ext/atom/atom-helpers.h \
- lv2/ns/ext/atom/atom.h \
- lv2/ns/ext/atom/forge.h \
- lv2/ns/ext/contexts/contexts.h \
- lv2/ns/ext/data-access/data-access.h \
- lv2/ns/ext/dynmanifest/dynmanifest.h \
- lv2/ns/ext/event/event-helpers.h \
- lv2/ns/ext/event/event.h \
- lv2/ns/ext/files/files.h \
- lv2/ns/ext/instance-access/instance-access.h \
- lv2/ns/ext/osc/osc-print.h \
- lv2/ns/ext/osc/osc.h \
- lv2/ns/ext/pui/pui.h \
- lv2/ns/ext/reference/reference.h \
- lv2/ns/ext/resize-port/resize-port.h \
- lv2/ns/ext/state/state.h \
- lv2/ns/ext/string-port/string-port.h \
- lv2/ns/ext/time/time.h \
- lv2/ns/ext/ui-resize/ui-resize.h \
- lv2/ns/ext/uri-map/uri-map.h \
- lv2/ns/ext/uri-unmap/uri-unmap.h \
- lv2/ns/ext/urid/urid.h \
- lv2/ns/extensions/ui/ui.h \
- lv2/ns/lv2core/lv2.h
+ ../doc/mainpage.dox \
+ ns/ext/atom/atom-buffer.h \
+ ns/ext/atom/atom-helpers.h \
+ ns/ext/atom/atom.h \
+ ns/ext/atom/forge.h \
+ ns/ext/contexts/contexts.h \
+ ns/ext/data-access/data-access.h \
+ ns/ext/dynmanifest/dynmanifest.h \
+ ns/ext/event/event-helpers.h \
+ ns/ext/event/event.h \
+ ns/ext/files/files.h \
+ ns/ext/instance-access/instance-access.h \
+ ns/ext/osc/osc-print.h \
+ ns/ext/osc/osc.h \
+ ns/ext/pui/pui.h \
+ ns/ext/reference/reference.h \
+ ns/ext/resize-port/resize-port.h \
+ ns/ext/state/state.h \
+ ns/ext/string-port/string-port.h \
+ ns/ext/time/time.h \
+ ns/ext/ui-resize/ui-resize.h \
+ ns/ext/uri-map/uri-map.h \
+ ns/ext/uri-unmap/uri-unmap.h \
+ ns/ext/urid/urid.h \
+ ns/extensions/ui/ui.h \
+ ns/lv2core/lv2.h
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -706,7 +706,7 @@ FILTER_SOURCE_FILES = NO
# Note: To get rid of all source code in the generated output, make sure also
# VERBATIM_HEADERS is set to NO.
-SOURCE_BROWSER = YES
+SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation.
@@ -816,7 +816,7 @@ HTML_FOOTER =
# the style sheet file to the HTML output directory, so don't put your own
# stylesheet in the HTML output directory as well, or it will be erased!
-HTML_STYLESHEET = doc/doxy-style.css
+HTML_STYLESHEET = ../doc/doxy-style.css
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index 74f5e96..078f67d 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -8,18 +8,13 @@
* (e.g. ext.lv2/ext.ttl), and an accompanying
* <a href="http://en.wikipedia.org/wiki/C99">C</a> header (e.g. ext.lv2/ext.h).
* The header documentation is generated with <a href="http://doxygen.org">
- * Doxygen</a> and hyperlinked (in both directions) with the extension
+ * Doxygen</a> and hyperlinked (in both directions) with the specification
* documentation generated from Turtle with
* <a href="http://drobilla.net/software/lv2specgen">lv2specgen</a>.
*
- * \par Header Documentation
- * \li <a href="annotated.html">Data Structures Index</a>
- * \li <a href="files.html">Files Index</a>
- *
- * \par Extension Documentation
- * \li <a href="../../lv2core">LV2 core documentation</a>
- * \li <a href="../../ext">Extensions at lv2plug.in/ns/ext</a>
- * \li <a href="../../extensions">Extensions at lv2plug.in/ns/extensions</a>
+ * \li <a href="../../">LV2 Specifications</a>
+ * \li <a href="annotated.html">Data Structures</a>
+ * \li <a href="files.html">Headers</a>
*/
#define NOTHING_HERE
diff --git a/gendoc.py b/gendoc.py
index cf2e340..571d73a 100755
--- a/gendoc.py
+++ b/gendoc.py
@@ -21,19 +21,19 @@ except:
shutil.copytree('lv2/ns', 'build/ns',
ignore=shutil.ignore_patterns('.*', 'waf', 'wscript', '*.in'))
-# Copy stylesheet to build directory
try:
os.mkdir('build/aux')
except:
pass
+# Copy stylesheet to build directory
shutil.copy('lv2specgen/style.css', 'build/aux/style.css')
URIPREFIX = 'http://lv2plug.in/ns/'
DOXPREFIX = 'ns/doc/html/'
SPECGENDIR = os.path.abspath('lv2specgen')
STYLEPATH = os.path.abspath('build/aux/style.css')
-TAGFILE = os.path.abspath('doclinks')
+TAGFILE = os.path.abspath('build/doclinks')
BUILDDIR = os.path.abspath('build')
doap = rdflib.Namespace('http://usefulinc.com/ns/doap#')
@@ -43,9 +43,14 @@ rdf = rdflib.Namespace('http://www.w3.org/1999/02/22-rdf-syntax-ns#')
devnull = open(os.devnull, 'w')
+# Enter build directory
+print("Entering directory `%s'\n" % os.path.abspath('build'))
+oldcwd = os.getcwd()
+os.chdir('build')
+
# Generate code (headers) documentation
print('## Generating header documentation with doxygen ##')
-subprocess.call('doxygen', stdout=devnull)
+subprocess.call(['doxygen', '../Doxyfile'], stdout=devnull)
def rescue_tags(in_path, out_path):
"Rescue Doxygen tag file from XML hell."
@@ -96,10 +101,6 @@ def subst_file(template, output, dict):
i.close()
o.close()
-print("Entering directory `%s'" % os.path.abspath('build'))
-oldcwd = os.getcwd()
-os.chdir('build')
-
extensions = []
print('\n## Generating specification documentation with lv2specgen ##')
@@ -225,7 +226,7 @@ subst_file('../lv2/ns/index.html.in', 'ns/index.html',
{ '@ROWS@': index_rows,
'@TIME@': datetime.datetime.utcnow().strftime('%F %H:%M UTC') })
-print("\nLeaving directory `%s'" % os.path.abspath('build'))
+print("\nLeaving directory `%s'" % os.getcwd())
os.chdir(oldcwd)
devnull.close()