Review Request 128213: Fix HTML documentation generation

[Michael Pyne]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/128213/#review96619
-----------------------------------------------------------



Regarding the alternative stylesheets, I don't think that's possible. However I've been able to approximate the effect. The KDE Docbook stylesheets use a '`kde.common`' parameter as the base URL for the HTML resources. While it defaults to using kio_help, you can point it to a separate directory (which should contains the contents of "$(kf5-config --install data)/doc/HTML/$LANG/kdoctools5-common").

You would then use the `--param` option to `meinproc5` to set `kde.common`. Here's the script I used to use to build kdesrc-build docs (before simply sending users to the docs.kde.org docs). You might experiment with stylesheets other than kde-chunk-online.xsl:

    #!/bin/sh
    # build-docs

    # We need to run this from right directory, i.e. the director we want generated
    # output to go to.

    PATH_TO_DOCS="../doc/index.docbook"
    COMMON_DIR="kdoctools5-common"
    COMMON_FILES=$(printf "'%s/'" "$COMMON_DIR") # The single quotes are exceedingly important

    DATA_DIR=$(kf5-config --install data)
    DATA_DIR=${DATA_DIR%/} # Remove trailing /

    DOC_SRCDIR="$DATA_DIR/kf5/kdoctools"
    XSLT="$DOC_SRCDIR/customization/kde-chunk-online.xsl"

    if [ ! -e "$COMMON_DIR" ]; then
        ln -s "$DATA_DIR/doc/HTML/en/$COMMON_DIR" .
    fi

    meinproc5 --srcdir "$DOC_SRCDIR" \
              --param kde.common="$COMMON_FILES" \
              --stylesheet "$XSLT" \
              "$PATH_TO_DOCS"

- Michael Pyne


On June 16, 2016, 4:43 p.m., Christoph Cullmann wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/128213/
> -----------------------------------------------------------
> 
> (Updated June 16, 2016, 4:43 p.m.)
> 
> 
> Review request for KDE Frameworks and Luigi Toscano.
> 
> 
> Repository: kdoctools
> 
> 
> Description
> -------
> 
> Fix the optional HTML documentation generation (which I would like to use for Windows/Mac)
> 
> Sidenote: The goal would be to have some html which can be used without khelpcenter and the help:/ ioslave.
> Is there some other stylesheet one could use for that?
> 
> 
> Diffs
> -----
> 
>   KF5DocToolsMacros.cmake e0a85b3 
> 
> Diff: https://git.reviewboard.kde.org/r/128213/diff/
> 
> 
> Testing
> -------
> 
> Before this patch: if you turn HTML docs on, not even cmake will complete, as the target names are broken.
> Now: make && make install for e.g. kate.git will create & install a index.html if HTML docs are turned on.
> 
> 
> Thanks,
> 
> Christoph Cullmann
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20160617/6b44d949/attachment.html>