Script 'mail_helper' called by obssrc Hello community, here is the log from the commit of package kapidox for openSUSE:Factory checked in at 2021-09-16 23:14:42 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Comparing /work/SRC/openSUSE:Factory/kapidox (Old) and /work/SRC/openSUSE:Factory/.kapidox.new.1899 (New) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "kapidox" Thu Sep 16 23:14:42 2021 rev:93 rq:918544 version:5.86.0 Changes: -------- --- /work/SRC/openSUSE:Factory/kapidox/kapidox.changes 2021-08-16 10:17:53.386632377 +0200 +++ /work/SRC/openSUSE:Factory/.kapidox.new.1899/kapidox.changes 2021-09-16 23:17:11.599954936 +0200 @@ -1,0 +2,10 @@ +Mon Sep 6 06:21:52 UTC 2021 - Christophe Giboudeaux <christo...@krop.fr> + +- Update to 5.86.0 + * New feature release + * For more details please see: + * https://kde.org/announcements/frameworks/5/5.86.0 +- Changes since 5.85.0: + * Mention this updates api.kde.org, use standard kde/src paths, improve language. + +------------------------------------------------------------------- Old: ---- kapidox-5.85.0.tar.xz kapidox-5.85.0.tar.xz.sig New: ---- kapidox-5.86.0.tar.xz kapidox-5.86.0.tar.xz.sig ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Other differences: ------------------ ++++++ kapidox.spec ++++++ --- /var/tmp/diff_new_pack.qfD82g/_old 2021-09-16 23:17:12.207955565 +0200 +++ /var/tmp/diff_new_pack.qfD82g/_new 2021-09-16 23:17:12.211955569 +0200 @@ -18,13 +18,13 @@ # Only needed for the package signature condition %bcond_without lang -%define _tar_path 5.85 +%define _tar_path 5.86 # Full KF5 version (e.g. 5.33.0) %{!?_kf5_version: %global _kf5_version %{version}} # Last major and minor KF5 version (e.g. 5.33) %{!?_kf5_bugfix_version: %define _kf5_bugfix_version %(echo %{_kf5_version} | awk -F. '{print $1"."$2}')} Name: kapidox -Version: 5.85.0 +Version: 5.86.0 Release: 0 Summary: Scripts and data for building API documentation License: BSD-2-Clause ++++++ kapidox-5.85.0.tar.xz -> kapidox-5.86.0.tar.xz ++++++ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.85.0/README.md new/kapidox-5.86.0/README.md --- old/kapidox-5.85.0/README.md 2021-07-22 14:09:44.000000000 +0200 +++ new/kapidox-5.86.0/README.md 2021-08-14 13:17:36.000000000 +0200 @@ -4,9 +4,10 @@ This framework contains scripts and data for building API documentation (dox) in a standard format and style. +https://api.kde.org holds the result. -The Doxygen tool is used to do the actual documentation extraction and -formatting, but this framework provides a wrapper script to make generating the +The [Doxygen](https://www.doxygen.nl) tool performs the actual documentation extraction and +formatting. This framework provides a wrapper script to make generating the documentation more convenient (including reading settings from the target framework or other module) and a standard template for the generated documentation. @@ -15,7 +16,7 @@ ## Dependencies ### Required -Python 3 is required to run the scripts. Additionally you +You need Python 3 to run the scripts. Additionally you need to have the jinja2 and yaml (or pyyaml) modules. The following command should install them for the current user: @@ -88,24 +89,25 @@ `examples`. See the doxygen documentation for help on how to refer to these files from the dox comments in the source files. -If you need to override any doxygen settings, put them in `docs/Doxyfile.local`. -A global settings file is defined in `src/kapidox/data/Doxyfile.global`. +If you need to override any doxygen settings, put them in a `docs/Doxyfile.local` in your project. +Global settings are defined in `src/kapidox/data/Doxyfile.global`. ## Generating the documentation -The tool for generating dox is `src/kapidox_generate`. Simply point it at the -folder you want to generate dox for (such as a framework checkout). +The tool for generating dox is `src/kapidox_generate`. +Change to an empty directory, then simply point it at the +folder you want to generate dox for (such as a frameworks checkout). For example, if you have a checkout of KCoreAddons at -~/src/frameworks/kcoreaddons, you could run +~/kde/src/frameworks/kcoreaddons, you could run - ~/src/frameworks/kapidox/src/kapidox_generate ~/src/frameworks/kcoreaddons + ~/kde/src/frameworks/kapidox/src/kapidox_generate ~/kde/src/frameworks/kcoreaddons and it would create a documentation in the current directory, which needs to be empty before executing the command. -The folders are recursively walked through, so you can also run it on -`~/src/frameworks` or `~/src`. For a lot of libraries, the generation can last -15-30 minutes and be several hundreds of MB, so be prepared! +kapidox recursively walks through folders, so you can also run it on +`~/kde/src/frameworks` or `~/src`. For a lot of libraries, the generation can last +15-30 minutes and use several hundreds of MB, so be prepared! Pass the --help argument to see options that control the behaviour of the script. @@ -121,14 +123,14 @@ frameworks with the `depdiagram-prepare` tool, like this: mkdir dot - ~/src/frameworks/kapidox/src/depdiagram-prepare --all ~/src/frameworks dot + ~/kde/src/frameworks/kapidox/src/depdiagram-prepare --all ~/kde/src/frameworks dot Then call `kgenframeworksapidox` with the `--depdiagram-dot-dir` option, like this: mkdir frameworks-apidocs cd frameworks-apidocs - ~/src/frameworks/kapidox/src/kapidox_generate --depdiagram-dot-dir ../dot ~/src/frameworks + ~/kde/src/frameworks/kapidox/src/kapidox_generate --depdiagram-dot-dir ../dot ~/kde/src/frameworks More fine-grained tools are available for dependency diagrams. You can learn about them in [depdiagrams](@ref depdiagrams). diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/kapidox-5.85.0/setup.py new/kapidox-5.86.0/setup.py --- old/kapidox-5.85.0/setup.py 2021-07-22 14:09:44.000000000 +0200 +++ new/kapidox-5.86.0/setup.py 2021-08-14 13:17:36.000000000 +0200 @@ -14,7 +14,7 @@ setup( name='kapidox', - version='5.85.0', + version='5.86.0', description='KDE API documentation generation tools', maintainer = 'Olivier Churlaud', maintainer_email = 'oliv...@churlaud.com',
