Generate *.devhelp2 index files, the Devhelp index file format version 1 is deprecated

pygobject / pgi-docgen

API Documentation Generator for PyGObject

https://lazka.github.io/pgi-docs/

GNU Lesser General Public License v2.1

127 stars 36 forks source link

Generate *.devhelp2 index files, the Devhelp index file format version 1 is deprecated #166

Closed ghost closed 6 years ago

ghost commented 6 years ago

Generate *.devhelp2 index files, the Devhelp index file format version 1 is deprecated.

When opening Devhelp from the terminal, there is a warning about the Devhelp index file format version 1 being deprecated, when Devhelp finds and reads such index files.

Unfortunately the format version 2 is not really documented, the best way to learn it is to open a *.devhelp2 file generated by GTK-Doc, for example the one for GLib or GTK+ (or a smaller library to have a smaller example).

lazka commented 6 years ago

Thanks.

Our current code generating it is here: https://github.com/pygobject/pgi-docgen/blob/master/pgidocgen/gen/data/ext/devhelp_fork.py