Ichthyostega
5c8e88e59e
Debian-Docbase allows to register some HTML documentation; My old package definition added placeholder config, which renders the documentation configuration invalid (as pointed out by Lintian). However, I still think it is a good idea to have the anchor point already defined, and thus I came up with the idea of in fact providing some usable placeholder content... As it turns out, we also have a placeholder page at the Lumiera website, where the User Manual is assumed to be located later — so why not extend this one and then provide the HTML-rendering for the DEB package? To allow for this setup * I have now extended the placeholder page for the Website to include some generic description about Lumiera (from the 'about' page) * Furthermore, I added the screenshot (from the »Outer Space« page) * and I use this a an opportunity to document the various test / demo facilities currently available in the GUI, since these are rather obscure. While only intended for the developer, it seems still worthwhile to describe the possible effects — it may well be that we retain some of that test/demo functionality and in that case, we have now already some starting point for a documentation * Then, to include that page as stand-alone HTML, I used the 'Print Edit WE'-plugin from Firefox, to encode the images as inline-base64 URLs (which are restored by a tiny JavaScript embedded into that page) * and last but not least, our SCons buildsystem needs the ability to install such a documentation file, since it seems most adequate to handle this requirement as part of the generic installation (and not hidden in some Debian scripting)
17 lines
410 B
Python
17 lines
410 B
Python
# -*- python -*-
|
|
##
|
|
## SConscript - SCons buildscript for Documentation
|
|
##
|
|
|
|
|
|
Import('env')
|
|
|
|
|
|
doxydoc = env.Doxygen('devel/Doxyfile')
|
|
env.Clean(doxydoc, doxydoc + ['devel/,doxylog','devel/doxygen-warnings.txt'])
|
|
|
|
# HTML-documentation: this is a *placeholder* (eventually we'll build a user manual via Asciidoc)
|
|
env.DocFile('devel', 'LumieraHelpLandingPage.html', 'manual-html/index.html')
|
|
|
|
|
|
Export('doxydoc')
|