Releases: graphinx/graphinx
Releases · graphinx/graphinx
Release 0.12.1
Release v0.12.0
BREAKING CHANGES
- config file has been reworked, see documentation.
Release 0.11.0
Added
- support for
static - checks for version mismatches between the installed Graphinx and the template's dependency
Changed
- the CLI now has subcommands instead of only flags
- templates cannot read introspection header values anymore
Release 0.10.0
Added
- new field
modules.metadataon built data that exposes arbitrary objects coming from modules'intro. Intended to be used for template-specific things (for example, in the default template, the accent color of a module) - new field
modules.iconSvgthat contains the module's icon file content as a string (assumes the given icon is a local SVG filepath) - new config property modules.filesystem.items.debug, to debug if specific items is are matched by a specific matcher
- new field
items.referencedBythat contains the list of items that reference that item.
Changed
- paths in the config file are now taken relative to the config file's location, not the current working directory. This makes the use of
--confignot too cumbersome - huge performance improvements! filesystem matchers are now pre-computed per-module before being run on every item
Removed
- undocumented feature that allowed specifying
manually_includedin a module intro's frontmatter to manually include stuff. Use filesystem matchers instead.
Fixed
- a bug where an empty
graphinx-*folder was created in the current working directory
Release 0.9.0
Added
- special integration for relay (connection and edge types) and result types (result and success types)
Fixed
- don't write debug “allitems.json” file
Release 0.8.0
Added
- mandatory description in config to fill the index page
- env variable GRAPHINX_ITEMS_LIMIT to limit the maximum count of items to categorize. Useful when developing templates and test data contains a lot of items
Changed
- branding.logo is now an object of dark and light, to allow setting a different logo on dark and light themes
- contribution and source config settings are now taken into account and exposed to templates
- the categorization process was revamped and is now much faster
- the initial template (generated with --init) has now pins the version of the declared json schema
- example now depends on a development tarball of the graphinx package. The example is not meant to be used directly anyways, and is instead also used internally to develop templates
Release 0.7.0
Added
- initial release