Changelog#

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased#

Fixed#

  • header shadow now only extends downward (#70)

  • the autosummary class template now correctly handles classes referenced through aliased modules (#71)

0.2.3#

Added#

  • scverse_doc.config.DEFAULTS is now a class (#69)

0.2.2#

Fixed#

  • run the private-base-skipping code on the real class names in more cases (#66)

  • make logo and search button fill sidebar (#67)

0.2.1#

Fixed#

  • Hiding private base classes no longer crashes when a base is a string or has no __name__ (#63)

0.2.0#

Added#

  • Annotate prose return sections’ items with the members of a returned tuple (#56)

  • release-notes directive, ported from scanpydoc (#51)

  • Parameters and attributes as definition lists, ported from scanpydoc’s definition_list_typed_field (#54)

  • xref_overrides, ported from scanpydoc’s qualname_overrides, also for Sphinx’ own annotations, and reporting unused entries (#53)

0.1.1#

Fixed#

  • Handle attributes, i.e annotated fields on classes (#47)

0.1.0#

Added#

  • scverse Sphinx theme: branding, dark mode, shared sidebar, footer, and announcement banner

  • Package registry, fetched at runtime: “scverse packages” dropdown and intersphinx cross-links

  • Source links: “edit this page” and repository icon

  • Read the Docs integration: version selector and search, both with dark mode

  • Autodoc, prose, and confval rendering extensions (from scverse-misc)