Skip to content

2.2.0

Compare
Choose a tag to compare
@felixfontein felixfontein released this 27 Jun 15:52
· 223 commits to main since this release

Release Summary

Bugfix and feature release improving rendering and linting.

Minor Changes

  • Collection docs linter - also validate seealso module and plugin destinations (#168, #171).
  • When linting collection plugin docs, make sure that array stubs [...] are used when referencing sub-options or sub-return values inside lists, and are not used outside lists and dictionaries (#173).

Bugfixes

  • Fix the way the Sphinx extension creates nodes for options and return values so they look identical for internal references, external (intersphinx) references, and unresolved references (#175).
  • Make sure that :ansopt: and :ansretval: create the same references as the labels created in the RST files (#167, #172).
  • Make sure that broken :ansopt: and :ansretval: parameters result in correctly rendered error messages (#175).
  • When trying to copying descriptions of non-existing plugins to seealso, references to these non-existing plugins were added in some cases, crashing the docs augmentation process (#169).