New doxygen script
Alex Merry
kde at randomguy3.me.uk
Sat Jan 11 02:32:10 UTC 2014
On 10/01/14 20:05, Alex Merry wrote:
> On 10/01/14 15:42, Aurélien Gâteau wrote:
>> Le vendredi 10 janvier 2014 03:30:03 Alex Merry a écrit :
>>> Hey Aurélien,
>>>
>>> I wrote a new script to generate apidocs. It's in Python rather than
>>> shell script (because (a) yay for proper programming languages and (b)
>>> cross-platformness).
>>>
>>> If you run it on a framework like KCoreAddons, you'll get actual bona
>>> fide apidocs (unlike if you try to run doxygen.sh on it). It even pulls
>>> in README.md as the main page text.
>>>
>>> It can be found in kde:clones/kapidox/alexmerry/kapidox on the
>>> frameworks branch.
>>
>> Nice! I was thinking about porting the doxygen.sh script to Python as well, to
>> help with maintainability and so that we can later use string.Template or even
>> Jinja to handle HTML generation, but you beat me to it :)
>
> Proper templating would be good; currently the substitution is a bit
> hackish.
Now with mustache-based templating (http://mustache.github.io/)! You
might need to do `pip pystache` to get it to run. There's also an
optional dependency on the Python yaml module (I haven't tested it
without that module, though).
The "lookinggood" branch is themed to match the main KDE website. I
left it on a separate branch in case we decide that theme isn't clear
enough (there's no sidebar, for example - all the menus are at the top).
Alex
More information about the Kde-frameworks-devel
mailing list