Summary

Migrate to gi-docgen

Review Request #905 — Created Aug. 24, 2021 and submitted Sept. 5, 2021, 3:37 p.m.

Information

Owner

grim

Repository

gplugin/gplugin

Branch

default

Bugs

Depends On

Reviewers

Groups

pidgin

People

Description

gi-docgen is apparently the future and it works much faster with no extra work like updating gplugin-docs.xml that gtk-doc required.

However, there are a few additional python dependencies for gi-docgen, notably python3-jinja2, python3-pygments, python3-toml, python3-typogrify. I'm in the process of updating the builders right now as the docs build by default now.

Testing Done

Ran locally and via the new convey plan.

Commits

Summary	ID
Replace gtk-doc with gi-docgen	c74b8aa36f687541116295031d5acb66695539bc

Issues

Description	From	Last Updated
Double plugin?	QuLogic	Aug. 30, 2021, 7:15 a.m.
Inconsistent quotes.	QuLogic	Aug. 30, 2021, 7:15 a.m.
library	QuLogic	Aug. 30, 2021, 7:15 a.m.
Spaces	QuLogic	Aug. 30, 2021, 7:15 a.m.
Not sure if you were hoping for this to link, but it won't in a literal block.	QuLogic	Aug. 30, 2021, 7:15 a.m.
The 'via' got dropped.	QuLogic	Aug. 30, 2021, 7:15 a.m.
successful	QuLogic	Aug. 30, 2021, 7:15 a.m.
successful	QuLogic	Aug. 30, 2021, 7:15 a.m.
Extra ]	QuLogic	Aug. 30, 2021, 7:16 a.m.
Python 3 should be 4 space indent, not tabs.	QuLogic	Aug. 30, 2021, 7:16 a.m.
Extra )?	QuLogic	Aug. 30, 2021, 7:16 a.m.
Spaces	QuLogic	Aug. 30, 2021, 7:16 a.m.
Spaces?	QuLogic	Aug. 30, 2021, 7:16 a.m.

Commits:

	Summary	ID
	Replace gtk-doc with gi-docgen	53d8f8d4160ad51ce4665340bcb1b85027a36b5a
	Replace gtk-doc with gi-docgen	77dd2ac2c5be875db3bde8bfd00a190b9ebca2ed

Diff:

Revision 2 (+1044 -1288)

Show changes

	.hgignore
	convey.yml
	meson.build
	gplugin/meson.build
	gplugin-gtk/meson.build
	gplugin-gtk/reference/Dockerfile
	gplugin-gtk/reference/gplugin-gtk-docs.xml
	gplugin-gtk/reference/gplugin-gtk.toml.in
	17 more

gplugin-gtk/reference/gplugin-gtk.toml.in (Diff revision 2)
The issue has been resolved. Show all issues
```
Double plugin?
```
gplugin-gtk/reference/gplugin-gtk.toml.in (Diff revision 2)
The issue has been resolved. Show all issues
```
Inconsistent quotes.
```
gplugin-gtk/reference/gplugin-gtk.toml.in (Diff revision 2)
The issue has been resolved. Show all issues
```
library
```
gplugin-gtk/reference/urlmap.js (Diff revision 2)
The issue has been resolved. Show all issues
```
Spaces
```
gplugin/reference/embedding.md (Diff revision 2)
The issue has been resolved. Show all issues
```
Not sure if you were hoping for this to link, but it won't in a literal block.
```
gplugin/reference/native-plugins.md (Diff revision 2)
The issue has been resolved. Show all issues
```
The 'via' got dropped.
```
gplugin/reference/native-plugins.md (Diff revision 2)
The issue has been resolved. Show all issues
```
successful
```
gplugin/reference/native-plugins.md (Diff revision 2)
The issue has been resolved. Show all issues
```
successful
```
gplugin/reference/native-plugins.md (Diff revision 2)
The issue has been resolved. Show all issues
```
Extra ]
```

gplugin/reference/python3.md (Diff revision 2)

The issue has been resolved. Show all issues

Python 3 should be 4 space indent, not tabs.

gplugin/reference/python3.md (Diff revision 2)
The issue has been resolved. Show all issues
```
Extra )?
```
gplugin/reference/urlmap.js (Diff revision 2)
The issue has been resolved. Show all issues
```
Spaces
```
meson.build (Diff revision 2)
The issue has been resolved. Show all issues
```
Spaces?
```

Commits:

	Summary	ID
	Replace gtk-doc with gi-docgen	77dd2ac2c5be875db3bde8bfd00a190b9ebca2ed
	Replace gtk-doc with gi-docgen	c74b8aa36f687541116295031d5acb66695539bc

Diff:

Revision 3 (+1044 -1288)

Show changes

	.hgignore
	convey.yml
	meson.build
	gplugin/meson.build
	gplugin-gtk/meson.build
	gplugin-gtk/reference/Dockerfile
	gplugin-gtk/reference/gplugin-gtk-docs.xml
	gplugin-gtk/reference/gplugin-gtk.toml.in
	17 more

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed