Skip to content

v1.0.1

Choose a tag to compare

@github-actions github-actions released this 02 Jun 07:10
· 4 commits to main since this release

v1.0.1

Highlights

  • Renames the project to OODocs, short for Object-Oriented Documentation Tool,
    and aligns the repository, package metadata, Python import path, CLI command,
    generated examples, and user-facing documentation around the oodocs name.
  • Reframes the README around object-oriented documentation: documents are typed
    Python object trees, not string templates or markup streams.
  • Keeps the authoring model focused on reusable objects such as Document,
    DocumentSettings, Chapter, Section, Paragraph, Table, Figure,
    Box, and CitationSource.

Compatibility Notes

  • The public package and module name are now oodocs. Update imports such as
    from docscriptor import Document to from oodocs import Document.
  • The command-line entry point is now oodocs. Update commands such as
    docscriptor build report.py --out artifacts to
    oodocs build report.py --out artifacts.
  • The public base exception is now OODocsError.
  • PyPI Trusted Publishing is configured for the renamed oodocs package and the
    Gonie-Gonie/oo-docs repository.

Release Notes

  • Package metadata, project URLs, package discovery, and console scripts now use
    oodocs.
  • Source packages, tests, examples, generated artifact names, and generated HTML
    class prefixes now use oodocs.
  • The local fallback version metadata is aligned with the 1.0.1 release line for
    source trees without git tag metadata.