Re: Doc buildscripts cleanup

[Han-Wen Nienhuys]

John Mandereau escreveu:
> Hello,
> 
> I've just commited the attached changes on my local Git branch, after a
> lot of testing and debugging.  The code should be clearer, I added a
> hack to copy the Info navigation bar to the footer and big-page docs are
> renamed to avoid silly conflicts in content-negotiation.
> 
> May I push this if it looks OK?  I'd like to push French doc updates
> along with this, too.

> 
> I'm a bit sorry I am slower than usual for pushing and replying to
> emails; I'll have more free time in end of March.


yes, please push. However, it would be nice if you would keep on standby
for a couple of days in case we have problems with using this.


> 
> Cheers
> 
> 
> ------------------------------------------------------------------------
> 
> diff --git a/buildscripts/add_html_footer.py b/buildscripts/add_html_footer.py
> index a7bc7e1..7c63755 100644
> --- a/buildscripts/add_html_footer.py
> +++ b/buildscripts/add_html_footer.py
> @@ -9,10 +9,23 @@ import time
>  
>  import langdefs
>  
> -default_header = r"""
> +# This is to try to make the docball not too big with almost duplicate files
> +# see process_links()
> +non_copied_pages = ['Documentation/user/out-www/lilypond-big-page',
> +                    'Documentation/user/out-www/lilypond-internals-big-page',
> +                    'Documentation/user/out-www/music-glossary-big-page',
> +                    'out-www/examples',
> +                    'Documentation/topdocs/out-www/NEWS',
> +                    'Documentation/topdocs/out-www/INSTALL',
> +                    'Documentation/bibliography/out-www/index',
> +                    'Documentation/out-www/THANKS',
> +                    'Documentation/out-www/DEDICATION',
> +                    'Documentation/topdocs/ou-www/AUTHORS']
> +

is this tested? ou-www surely doens't work?

>  
>  def add_html_footer (package_name = '',
>                       package_version = '',
> -                     header = default_header,
> -                     footer = default_footer,
>                       target = 'offline',
> -                     mail_address = '(address unknown)',
> -                     pages_dict = {},
> -                     out_root = '',
>                       name_filter = lambda s: s):
>      """Add header, footer to a number of HTML files
>  
>      Arguments:
>       package_name=NAME         set package_name to NAME
>       package_version=VERSION   set package version to VERSION
> -     header=TEXT               use TEXT as header
> -     footer=TEXT               use TEXT as footer
>       targets=offline|online    set page processing depending on the target
>            offline is for reading HTML pages locally
>            online is for hosting the HTML pages on a website with content
>              negotiation
> -     mail_address              set \"Report errors to\" link
> -     pages_dict                a dictionnary returned by build_pages_dict()
> -     out_root                  a path prefix where to write HTML pages
>       name_filter               a HTML file name filter

i'd consider passing a dict, and initing subst from that dict.




-- 

Han-Wen Nienhuys - address@hidden - http://www.xs4all.nl/~hanwen

LilyPond Software Design
 -- Code for Music Notation
http://www.lilypond-design.com