Skip to content

v0.15.0

Latest

Choose a tag to compare

@rich-iannone rich-iannone released this 10 Jul 18:28
8eca1ba

Great Docs v0.15.0 provides improvements to API documentation accuracy, site configuration options, and SEO. This release introduces a new package dependencies metadata page that automatically documents package requirements, improves API reference handling for versioned documentation, refactors the API reference pipeline for better maintainability, and adds new configuration options for CLI reference pages and CSS customization.

New Features

  • Package dependencies metadata page — Automatically generate a metadata page that documents package dependencies and version information, providing visitors with clear visibility into package requirements. (#255)

Enhancements

  • CLI reference pages now support an index page with configurable options for better organization and navigation of command documentation. (#244)
  • Site CSS customization options are now properly copied to the build directory during site generation. (#252)

Bug Fixes

  • GT tables now display correctly in dark mode with proper CSS styling. (#235)
  • Skill markdown files are no longer rendered in the documentation site by enumerating specific Quarto render globs. (#236)
  • Dataclass and class definitions with methods now display empty ClassName() signatures correctly. (#238)
  • YAML frontmatter is no longer embedded in rendered API documentation. (#239)
  • Dataclass fields can now be documented using either Attributes or Parameters sections without causing duplication. (#241)
  • API reference pages for versioned (tagged) documentation are now complete and include all documented symbols. (#240)
  • Source code links in API documentation are now generated correctly. (#245)
  • The importable module name is now used instead of the PyPI project name for accurate package identification. (#251)
  • Search engine crawlers now receive proper references to llms.txt and llms-full.txt in the robots.txt file. (#254)

Documentation

  • Added comprehensive quartodoc migration guide to the API documentation for users transitioning from quartodoc to Great Docs. (#253)

Maintenance

  • API reference pipeline has been refactored for improved code organization and maintainability. (#249)
  • Griffe dependency updated to ~=2.1.0 for enhanced Python introspection capabilities. (#242)