commit kapidox for openSUSE:Factory
Hello community, here is the log from the commit of package kapidox for openSUSE:Factory checked in at 2014-09-12 17:03:26 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Comparing /work/SRC/openSUSE:Factory/kapidox (Old) and /work/SRC/openSUSE:Factory/.kapidox.new (New) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Package is "kapidox" Changes: -------- --- /work/SRC/openSUSE:Factory/kapidox/kapidox.changes 2014-08-16 15:42:33.000000000 +0200 +++ /work/SRC/openSUSE:Factory/.kapidox.new/kapidox.changes 2014-09-12 17:04:31.000000000 +0200 @@ -1,0 +2,7 @@ +Tue Sep 9 09:49:31 UTC 2014 - hrvoje.senjan@gmail.com + +- Update to 5.2.0 + * For more details please see: + http://kde.org/announcements/kde-frameworks-5.2.php + +------------------------------------------------------------------- Old: ---- kapidox-5.1.0.tar.xz New: ---- kapidox-5.2.0.tar.xz ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Other differences: ------------------ ++++++ kapidox.spec ++++++ --- /var/tmp/diff_new_pack.eHY04R/_old 2014-09-12 17:04:32.000000000 +0200 +++ /var/tmp/diff_new_pack.eHY04R/_new 2014-09-12 17:04:32.000000000 +0200 @@ -17,7 +17,7 @@ Name: kapidox -Version: 5.1.0 +Version: 5.2.0 Release: 0 Requires: doxygen BuildRequires: fdupes ++++++ kapidox-5.1.0.tar.xz -> kapidox-5.2.0.tar.xz ++++++ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/.reviewboardrc new/kapidox-5.2.0/.reviewboardrc --- old/kapidox-5.1.0/.reviewboardrc 2014-07-15 21:20:31.000000000 +0200 +++ new/kapidox-5.2.0/.reviewboardrc 2014-09-02 21:01:58.000000000 +0200 @@ -2,4 +2,4 @@ REPOSITORY = 'git://anongit.kde.org/kapidox' BRANCH = 'master' TARGET_GROUPS = 'kdeframeworks' -TARGET_PEOPLE = 'gateau' +TARGET_PEOPLE = 'alexmerry' diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/metainfo.yaml new/kapidox-5.2.0/metainfo.yaml --- old/kapidox-5.1.0/metainfo.yaml 2014-07-15 21:20:31.000000000 +0200 +++ new/kapidox-5.2.0/metainfo.yaml 2014-09-02 21:01:58.000000000 +0200 @@ -1,4 +1,4 @@ -maintainer: gateau +maintainer: alexmerry description: Scripts and data for building API documentation (dox) in a standard format and style tier: 1 type: functional diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/setup.py new/kapidox-5.2.0/setup.py --- old/kapidox-5.1.0/setup.py 2014-07-15 21:20:31.000000000 +0200 +++ new/kapidox-5.2.0/setup.py 2014-09-02 21:01:58.000000000 +0200 @@ -5,7 +5,7 @@ setup( name='kapidox', - version='5.0.0', + version='5.2.0', description='KDE API documentation generation tools', maintainer = 'Aurélien Gâteau', maintainer_email = 'agateau@kde.org', diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/src/kapidox/data/frameworks.yaml new/kapidox-5.2.0/src/kapidox/data/frameworks.yaml --- old/kapidox-5.1.0/src/kapidox/data/frameworks.yaml 2014-07-15 21:20:31.000000000 +0200 +++ new/kapidox-5.2.0/src/kapidox/data/frameworks.yaml 2014-09-02 21:01:58.000000000 +0200 @@ -6,7 +6,14 @@ desktop applications (such as KNewStuff, for fetching downloadable add-on content in an application, or the powerful KIO multi-protocol file access framework). - - The frameworks are divided into four tiers. + - The KDE Frameworks can be used in CMake-based and QMake-based projects, + and most of them are portable to at least Windows, Mac and Linux. The + documentation of each framework has code snippets that show how to include + the framework in a QMake or CMake project. + - The frameworks are divided into four tiers, based on the kind of + dependencies that they have. For instance, Tier 1 frameworks depend on Qt + and possibly some third-party libraries, but not on other frameworks. This + makes them easy to integrate into existing applications. tiers: 1: Tier 1 frameworks depend only on Qt (and possibly a small number of other diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/src/kapidox/data/htmlresource/kde.css new/kapidox-5.2.0/src/kapidox/data/htmlresource/kde.css --- old/kapidox-5.1.0/src/kapidox/data/htmlresource/kde.css 2014-07-15 21:20:31.000000000 +0200 +++ new/kapidox-5.2.0/src/kapidox/data/htmlresource/kde.css 2014-09-02 21:01:58.000000000 +0200 @@ -46,8 +46,19 @@ border: 1px solid; } +dt a { + font-weight: bold; +} + +dt { + margin-top: 0.8em; +} +dt:first-child { + margin-top: 0; +} dd { margin-left: 1em; + color: #323232; } form { @@ -168,6 +179,17 @@ display: none; } +/* The Doxygen-provided page title, that is already displayed in the header */ +div.header, div#top { + display: none; +} + +/* The Doxygen content feels "out of place" if it has a margin different from the rest of the page */ +div.contents { + margin-left: 0; + margin-right: 0; +} + /* Provides the thin vertical grey line on the left of the menu */ #body_wrapper { margin: 0 auto; @@ -181,6 +203,12 @@ width: 73%; } +/* Additional info at the top of classes */ +.additional_info { + float: right; + text-align: right; +} + /* ** Listing */ @@ -259,6 +287,14 @@ /* ** Footer */ +.copyrights { + border-top: 1px solid #dddddd; + margin-top: 10px; + padding-top: 5px; + text-align: center; + color: #555555; +} + #footer { background: #eeeeee; } diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/src/kapidox/data/templates/base.html new/kapidox-5.2.0/src/kapidox/data/templates/base.html --- old/kapidox-5.1.0/src/kapidox/data/templates/base.html 2014-07-15 21:20:31.000000000 +0200 +++ new/kapidox-5.2.0/src/kapidox/data/templates/base.html 2014-09-02 21:01:58.000000000 +0200 @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <head> - <title>{% block title %}{% endblock %}</title> + <title>{% block page_title %}{% endblock %}</title> <style type="text/css"> .cp-doNotDisplay { display: none; } @@ -45,7 +45,7 @@ <div> <div> <img alt ="" src="{{resources}}/top-kde.jpg"/> - {{title}} + {{title}} - {% block title %}{% endblock %} </div> </div> </div> diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/src/kapidox/data/templates/doxygen.html new/kapidox-5.2.0/src/kapidox/data/templates/doxygen.html --- old/kapidox-5.1.0/src/kapidox/data/templates/doxygen.html 2014-07-15 21:20:31.000000000 +0200 +++ new/kapidox-5.2.0/src/kapidox/data/templates/doxygen.html 2014-09-02 21:01:58.000000000 +0200 @@ -1,10 +1,17 @@ {% extends "base.html" %} -{% block title %}{{ dox.projectname }} - {{ dox.title }}{% endblock %} +{% block page_title %}{{ dox.projectname }} - {{ dox.title }}{% endblock %} +{% block title %}{{ dox.title }} ({{ dox.projectname }}){% endblock %} {% block content %} <h2><a name="content"></a>{{ dox.projectname }}</h2> +{% if classname %} +<p class="additional_info"> + <a href="http://lxr.kde.org/ident?v=kf5-qt5&_i={{ classname }}">View on LXR</a> +</p> +{% endif %} + {{ dox.content }} <div class="copyrights"> @@ -21,6 +28,10 @@ {% endblock %} {% block sidebar %} +{% if fwinfo %} + {% include "fwinfo.html" %} +{% endif %} + <div class="menu_box"> <a name="cp-menu" /> <div class="menutitle"> diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/src/kapidox/data/templates/frameworks.html new/kapidox-5.2.0/src/kapidox/data/templates/frameworks.html --- old/kapidox-5.1.0/src/kapidox/data/templates/frameworks.html 2014-07-15 21:20:31.000000000 +0200 +++ new/kapidox-5.2.0/src/kapidox/data/templates/frameworks.html 2014-09-02 21:01:58.000000000 +0200 @@ -43,7 +43,7 @@ </div> <span class="framework-description">{{fw.description}}</span> </td> - <td class="framework-detail-column framework-maintainer-column">{{ fw.maintainer }}</td> + <td class="framework-detail-column framework-maintainer-column">{% set fwinfo = fw %}{% include "fwmaintainer.html" %}</td> <td class="framework-detail-column framework-type-column">{{ fw.type }}</td> </td> </tr> @@ -51,7 +51,8 @@ </table> {% endmacro %} -{% block title %}{{title}} - Frameworks{% endblock %} +{% block page_title %}{{title}} - Frameworks{% endblock %} +{% block title %}Frameworks{% endblock %} {% block head %} <script type="text/javascript" src="{{resources}}/notetip.js"></script> @@ -73,12 +74,13 @@ </div> </div> <div class="contents"> + <h2>The KDE Frameworks</h2> <div class="textblock"> {% for para in tierinfo.intro %} <p>{{ para }}</p> {% endfor %} </div> - <h2>Frameworks</h2> + <h2>List of Frameworks by Tier</h2> {% for tier, frameworks in framework_lst|groupby('tier') %} <h3><a name="fw-tier{{ tier }}"></a>Tier {{tier}}</h3> <p>{{ tierinfo.tiers[tier] }}</p> diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/src/kapidox/data/templates/fwinfo.html new/kapidox-5.2.0/src/kapidox/data/templates/fwinfo.html --- old/kapidox-5.1.0/src/kapidox/data/templates/fwinfo.html 1970-01-01 01:00:00.000000000 +0100 +++ new/kapidox-5.2.0/src/kapidox/data/templates/fwinfo.html 2014-09-02 21:01:58.000000000 +0200 @@ -0,0 +1,53 @@ +<div class="menu_box"> + <div class="menutitle"> + <div> + <h2>{{ dox.projectname }} : {{ fwinfo.description }}</h2> + </div> + </div> + + <p style="text-align: center"><a style="font-weight: bold;" href="http://inqlude.org/libraries/{{ fwinfo.fancyname|lower }}.html">Download on <span style="color: black;">#In<span style="color: #80C342;">q</span>lude</span></a></p> + + <dl> + <dt>Maintainer</dt> + <dd>{% include "fwmaintainer.html" %}</dd> + + <dt>Dependencies</dt> + {% if fwinfo.tier >= 2 %} + <dd><a href="http://qt-project.org/">Qt 5</a></dd> + <dd><a href="http://api.kde.org/frameworks-api/frameworks5-apidocs/#fw-tier{{ fwinfo.tier - 1 }}">Other frameworks</a></dd> + {% else %} + <dd><a href="http://qt-project.org/">Qt 5</a>, no other framework required</dd> + {% endif %} + + <dt>Supported platforms</dt> + <dd> + {% for platform in fwinfo.platforms %} + {% if platform.name == "All" %} + Linux, MacOS X, Windows + {% elif platform.name == "UNKNOWN" %} + All the platforms supported by Qt + {% else %} + {{ platform.name }}{% if not loop.last %}, {% endif %} + {% endif %} + {% endfor %} + </dd> + + <dt>Community</dt> + <dd>IRC channel: {{ fwinfo.irc|default("#kde-devel") }} on Freenode</dd> + <dd>https://mail.kde.org/mailman/listinfo/{{ fwinfo.mailinglist|default("kde-frameworks-devel") }}">Mailing list</a></dd> + +{% if fwinfo.libraries|count != 0 %} + <dt>Use with <a href="https://techbase.kde.org/Development/Tutorials/CMake">CMake</a></dt> + <dd><pre class="fragment">find_package({{ fwinfo.cmakename }}) +target_link_libraries(yourapp{% for lib in fwinfo.libraries %} {{ lib.cmake }}{% endfor %})</pre></dd> + +{% endif %} +{% if fwinfo.libraries|selectattr("qmake")|list|count != 0 %} + <dt>Use with QMake</dt> + <dd><pre class="fragment">QT +={% for lib in fwinfo.libraries|selectattr("qmake") %} {{ lib.qmake }}{% endfor %}</pre></dd> +{% endif %} + + <dt>Clone URL</dt> + <dd><pre class="fragment">git clone <a href="https://projects.kde.org/projects/frameworks/{{ fwinfo.fancyname|lower }}/repository">git://anongit.kde.org/{{ fwinfo.fancyname|lower }}.git</a></pre></dd> + </dl> +</div> diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/src/kapidox/data/templates/fwmaintainer.html new/kapidox-5.2.0/src/kapidox/data/templates/fwmaintainer.html --- old/kapidox-5.1.0/src/kapidox/data/templates/fwmaintainer.html 1970-01-01 01:00:00.000000000 +0100 +++ new/kapidox-5.2.0/src/kapidox/data/templates/fwmaintainer.html 2014-09-02 21:01:58.000000000 +0200 @@ -0,0 +1,5 @@ + {% if not fwinfo.maintainer %} + <a href="mailto:kde-devel@kde.org">The KDE Community</a> + {% else %} + <a href="mailto:{{ fwinfo.maintainer.email }}">{{ fwinfo.maintainer.name }} <{{ fwinfo.maintainer.email }}></a> + {% endif %} diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/src/kapidox/generator.py new/kapidox-5.2.0/src/kapidox/generator.py --- old/kapidox-5.1.0/src/kapidox/generator.py 2014-07-15 21:20:31.000000000 +0200 +++ new/kapidox-5.2.0/src/kapidox/generator.py 2014-09-02 21:01:58.000000000 +0200 @@ -42,6 +42,10 @@ from urllib.parse import urljoin except ImportError: from urlparse import urljoin +try: + from httplib import HTTPConnection +except ImportError: + from http.client import HTTPConnection import jinja2 @@ -53,6 +57,7 @@ "copy_dir_contents", "generate_apidocs", "search_for_tagfiles", + "download_kde_identities", "WARN_LOGFILE", "build_classmap", "postprocess", @@ -75,6 +80,7 @@ 'modulename', 'fancyname', 'title', + 'fwinfo', # KApidox files 'doxdatadir', 'resourcedir', @@ -160,7 +166,7 @@ return os.path.join(pathorurl1,*args) -def find_tagfiles(docdir, doclink=None, flattenlinks=False, _depth=0, exclude=None): +def find_tagfiles(docdir, doclink=None, flattenlinks=False, exclude=None, _depth=0): """Find Doxygen-generated tag files in a directory The tag files must have the extention .tags, and must be in the listed @@ -247,6 +253,28 @@ return [] +def download_kde_identities(): + """Download the "accounts" file on the KDE SVN repository in order to get + the KDE identities with their name and e-mail address + """ + logging.info("Downloading KDE identities") + conn = HTTPConnection("websvn.kde.org") + conn.request("GET", "/*checkout*/trunk/kde-common/accounts") + r = conn.getresponse() + + if r.status != 200: + logging.error("Unable to download identities: " + r.reason) + return {} + + maintainers = {} + + for line in r.read().decode('utf8').split('\n'): + parts = line.split() + if len(parts) >= 3: + maintainers[parts[0]] = {'name': ' '.join(parts[1:-1]), 'email': parts[-1]} + + return maintainers + def copy_dir_contents(directory, dest): """Copy the contents of a directory @@ -379,8 +407,15 @@ if name.endswith('.html'): path = os.path.join(htmldir, name) newpath = path + '.new' + + if name != 'classes.html' and name.startswith('class'): + mapping['classname'] = name[5:-5].split('_1_1')[-1] + else: + mapping['classname'] = None + with codecs.open(path, 'r', 'utf-8', errors='ignore') as f: mapping['dox'] = parse_dox_html(f) + with codecs.open(newpath, 'w', 'utf-8') as outf: try: html = tmpl.render(mapping) @@ -539,6 +574,7 @@ 'doxygencss': 'doxygen.css', 'resources': ctx.resourcedir, 'title': ctx.title, + 'fwinfo': ctx.fwinfo, 'copyright': copyright, 'api_searchbox': ctx.api_searchbox, 'doxygen_menu': {'entries': menu_items(ctx.htmldir, ctx.modulename)}, diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.1.0/src/kgenframeworksapidox new/kapidox-5.2.0/src/kgenframeworksapidox --- old/kapidox-5.1.0/src/kgenframeworksapidox 2014-07-15 21:20:31.000000000 +0200 +++ new/kapidox-5.2.0/src/kgenframeworksapidox 2014-09-02 21:01:58.000000000 +0200 @@ -31,6 +31,7 @@ import argparse import logging +import codecs import os import shutil import subprocess @@ -149,7 +150,7 @@ 'available_platforms': sorted(available_platforms), } tmpl = create_jinja_environment(doxdatadir).get_template('frameworks.html') - with open(outputfile, 'w') as outf: + with codecs.open(outputfile, 'w', 'utf-8') as outf: outf.write(tmpl.render(mapping)) @@ -203,7 +204,7 @@ return True -def create_fw_info(frameworksdir, modulename): +def create_fw_info(frameworksdir, modulename, maintainers): fwdir = os.path.join(frameworksdir, modulename) if not os.path.isdir(fwdir): return None @@ -231,6 +232,7 @@ return None metainfo.update({ + 'maintainer': maintainers.get(metainfo['maintainer'], None), 'modulename': modulename, 'fancyname': fancyname, 'srcdir': fwdir, @@ -245,6 +247,7 @@ # Names modulename=fwinfo['modulename'], fancyname=fwinfo['fancyname'], + fwinfo=fwinfo, # KApidox files resourcedir='../..', # Input @@ -329,10 +332,11 @@ doclink = args.qtdoc_link, flattenlinks = args.qtdoc_flatten_links, searchpaths = ['/usr/share/doc/qt5', '/usr/share/doc/qt']) + maintainers = download_kde_identities() tiers = {1:[],2:[],3:[],4:[]} for modulename in os.listdir(args.frameworksdir): - fwinfo = create_fw_info(args.frameworksdir, modulename) + fwinfo = create_fw_info(args.frameworksdir, modulename, maintainers) if fwinfo: tiers[fwinfo["tier"]].append(fwinfo) -- To unsubscribe, e-mail: opensuse-commit+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-commit+help@opensuse.org
participants (1)
-
root@hilbert.suse.de