Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
gtk
gtk
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 1,147
    • Issues 1,147
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 141
    • Merge Requests 141
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • GNOME
  • gtkgtk
  • Merge Requests
  • !3222

Open
Opened Feb 18, 2021 by Emmanuele Bassi@ebassi👣Maintainer
  • Report abuse
Report abuse

Move API reference to gi-docgen

  • Overview 2
  • Commits 469
  • Pipelines 44
  • Changes 261+

GTK-Doc is falling into disrepair, and has various problems:

  • redundant C parsing compared to the introspection data
  • complicated set up, with multiple files required to generate the documentation
  • custom Markdown implementation
  • custom HTML generator
  • DocBook → HTML roundtripping, with slow xsltproc transformation process
  • outdated, non-responsive HTML style

The gi-docgen tool aims to solve these issues, by using only the introspection data to build the declaration and symbols tree, as well as extracting their documentation. Additionally, it transforms Markdown into HTML directly, and uses templates similar to static website generators that make it easy to restructure the HTML and style.

Edited Mar 05, 2021 by Emmanuele Bassi
Assignee
Assign to
Reviewer
Request review from
None
Milestone
None
Assign milestone
Time tracking
Reference: GNOME/gtk!3222
Source branch: ebassi/gidocgen