Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • gtk gtk
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 1,605
    • Issues 1,605
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 220
    • Merge requests 220
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • GNOMEGNOME
  • gtkgtk
  • Merge requests
  • !3222

Move API reference to gi-docgen

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Emmanuele Bassi requested to merge ebassi/gidocgen into master Feb 18, 2021
  • Overview 3
  • Commits 471
  • Pipelines 49
  • Changes 263+

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
Reviewers
Request review from
Time tracking
Source branch: ebassi/gidocgen