Skip to content
Tags give the ability to mark specific points in history as being important
  • 2023.3
    96f2e9b9 · Release gi-docgen 2023.3 ·
    Release: gi-docgen 2023.3
    Gi-docgen 2023.3
    
    Fixed
    -----
    
    - Add missing dependency [#175]
    - Add missing test data to the source archive [#174]
    
  • 2023.2
    e038d5e3 · Release 2023.2 ·
    Release: gi-docgen 2023.2
    gi-docgen 2023.2
    
    Added
    -----
    
    - Use packaging module to properly compare versions
    - Add "implements" in class definition pseudocode
    - Ignore the first class instance struct field
    - Parse default-value attribute [#103]
    - Test the gtk-doc sigil parsing
    - Support admonitions in docblocks [#170]
    - Add link to the extra content files location in the source repository [#118]
    - Search for GIR XML in `$GI_GIR_PATH` and `/usr/share/gir-1.0` [!196]
    - Add fallback for missing "since" [!198]
    
    Changed
    -------
    
    - Redesign the search results
    - Redesign the index for enumeration types
    
    Fixed
    -----
    
    - Match dependencies list in the index and sidebar [!177]
    - Use KeyboardEvent.key to focus search input [#151]
    - Build fixes for subproject use [!185]
    - Remove display:flex from headings [#147]
    - Split transfer notes based on direction [#141]
    - Clarify signal flags [!189]
    - Hide build section if empty [#160]
    - Always explicitely use utf-8 when reading/writing files [!193]
    - use `color-scheme: dark` when in dark mode [!188]
    
  • 2023.1
    63b4fad4 · Release gi-docgen 2023.1 ·
    Gi-docgen 2023.1
    
    Added
    -----
    
    - Use tomlib for Python >= 3.11 and tomli/toml for Python < 3.11 [!168, !172]
    
    Fixed
    -----
    
    - Use the proper link fragment for interface prerequisite [#148]
    
  • 2022.2
    bddd024b · docs: Add "serve" command ·
    GI-DocGen 2022.2
    
    Changes since 2022.1
    --------------------
    
    * Use const.*.html instead of constant.*.html for search index links [!146]
    * Remove "terms" from index.json, rewrite commandline search to work without it [!148]
    * Add interface type description [!149]
    * Fix failure to generate link to error domain [!151]
    * Make log.log() thread safe [#129]
    * Quote string constant values [#128]
    * Set the license of the generated documentation [#133]
    * Support (scope forever) [!155]
    * Add a way to frame images [!156]
    * Use the appropriate namespace for indices [#137]
    * Fix type annotations for Repository packages and c_includes [!160]
    * Add py.typed to comply with PEP561 [!159]
    * Add links to external classes in the hierarchy [#132]
    * Use definition lists for callable arguments [#123]
    * Improve styles [!165]
    * Use definition lists for callable arguments
    * Clarify generated description for GError arguments
    * Clarify generated description for nullable in/out arguments
    * Add emblems for versions and stability
    * Require a sufficient minimum dependency of markdown [!166]
    * Add a "serve" command
    
  • 2022.1
    37b04455 · Release gi-docgen 2022.1 ·
    Gi-docgen 2022.1
    
    Changes since 2021.8
    --------------------
    
    - Do not qualify type names that are already qualified [#111]
    - Handle implied zero-terminated=1 attribute [!115]
    - Display type note for strings inside arrays [!116]
    - Use C types for string and property types [!117]
    - Add support for OpenSearch [!118, Corentin Noël]
    - Fix links to callback types [!119]
    - Validate the "type" link fragment [!120]
    - Split type and array parsing [!121]
    - Add exception mode to the GIR parser [!122]
    - Handle missing type information in arguments [!123]
    - Add more contrast to the dimmed text class [#116]
    - Improve classification of pointer arguments [#117]
    - Add blurb when eliding inherited methods [#112]
    - Include bits in structure fields [#119]
    - Add a test suite for the gi-docgen link generator [!129]
    - Style keyboard shortcuts like libadwaita [#122, Jakub Steiner]
    - Do not require a message for deprecations [!132, !139]
    - Add anchors for enumeration values [!135, Niels De Graef]
    - Add a ToC for the page navigation side bar [#124, !136, !138, !142, Niels De Graef]
    - Fix pointer type detection [#127]
    - Note functions that are not introspectable or that have been shadowed [!144]
    - Split "related" libraries from "dependencies" [!145]
  • 2021.8 Release: GI-Docgen 2021.8
    GI-Docgen 2021.8
    
    Changes since 2021.7
    --------------------
    
    - Allow `id` fragments to link across namespace boundaries [!97]
    - Support links to have custom text [#100]
    - Decrease the max font size [!99, Patrick Griffis]
    - Improve output for properties and signals [#106]
    - Save last search in the history [#102]
    - Don't crash on unlabelled array elements [!92, Guido Günther]
    - Move type functions near constructors [#99]
    - Switch to Solarized for syntax highlighting [#101]
    - Use the C type for callback types in search results [!106]
    - Generate proper cross-reference links [#107]
    - Parse and use new gobject-introspection property attributes [!108]
    - Properly identify (type, gpointer) types [#110]
    - List the interface implementations in a namespace [#104]
    - List the class descendants in a namespace [#105]
    
  • 2021.7
    GI-DocGen 2021.7
    
    Changes since 2021.6:
    
    - Add a "check" sub-command [#51]
    - Allow defining multiple content directories
    - Detect gtk-doc code blocks for JavaScript
    - Multiple changes to the basic template
    - Add in-page content navigation
    - Filter hidden data from indices
    - Allow defining hidden symbols matching a regular expression
    - Handle (attribute element-type) annotation for GListModel
    - Fix class method linking [#92]
    - Fix links to callback type arguments
    - Fix argument listing in class methods
    - Don't grab the 's' key when the sidebar is hidden [#97]
    - Index the extra content files for search [#64]
    - Fix gtk-doc sigil handling in code blocks
    - Re-instate gtk-doc `()` function detection
    
  • 2021.6 Release: 2021.6
    gi-docgen 2021.6
    
    Changes since last version:
    
     - Add more files to the source dist [Simon McVittie, !61]
     - Deal with loops caused by unqualified ancestor names [!62]
     - Bind the 's' key to the search entry [Marc-André Lureau, !63]
     - Fix issues found by Coverity [#78]
     - Use a stylable separator for headings [#81]
     - Do not use gtk-doc function matching [#80]
     - Expose the "optional" GIR attribute in templates [Matthias Clasen, !68]
     - Generate argument description for GError [#86]
     - Redesign the arguments and return value tables [#84, #90]
     - Handle missing 'dot' binary [#88]
     - Validate links and warn about unknown fragments [#89]
     - Improve the types hierarchy [#48]
     - Add `callback` link fragment
    
  • 2021.5
    7dee8593 · Release gi-docgen 2021.5 ·
    gi-docgen 2021.5
    
  • 2021.4
    b3b067a5 · Release gi-docgen 2021.4 ·
    gi-docgen 2021.4
    
  • 2021.2
    24bb7e66 · Update version to 2021.2 ·
    gi-docgen 2021.2
    
    Brown paper bag release.
    
     - Install the missing JavaScript files for the basic template
    
  • 2021.1 Release: 2021.1
    gi-docgen 2021.1
    
    Initial release of gi-docgen. Still formally in beta, but good enough to
    generate the GTK and Pango API reference.