Skip to content

Releases: gnu-octave/pkg-octave-doc

pkg-octave-doc-0.7.3

Choose a tag to compare

@pr0m1th3as pr0m1th3as released this 21 Jul 10:12
  • Demo figures are now saved as SVG instead of PNG and drawn at a reduced size, for sharper and lighter documentation pages.
  • Each demo is rendered as a collapsible "Example" card. On classdef pages the cards start collapsed to keep long pages short, while function pages and grouped-classdef method pages keep them expanded.
  • Examples can be cross-referenced from within a docstring: write @url{#exampleN} and it links to that demo's card on the same page, automatically expanding and scrolling to it when followed. The short reference is expanded to a unique per-owner anchor, so references never collide even when several members' demos share one page.
  • Restored math rendering by loading MathJax from a live CDN; the formerly used cdn.mathjax.org was retired in 2017, so @tex / $$ display math had silently stopped rendering on generated pages.
  • Updated the README documentation guidelines to cover example cross-references and the collapsible demo cards.

pkg-octave-doc-0.7.2

Choose a tag to compare

@pr0m1th3as pr0m1th3as released this 10 Jul 13:39
  • Work-around to avoid core Octave classdef bug poisoning demo builds.
  • Multitables are now rendered in a modern Bootstap-5 compatible way.
  • The former conversion of x to × inside @math{} tags is removed.

pkg-octave-doc-0.7.1

Choose a tag to compare

@pr0m1th3as pr0m1th3as released this 09 Jul 02:28
  • Demos are now rendered as an interleaved notebook: each statement's console output and any figures appear right below the code that produced them, instead of being aggregated at the end of the demo.
  • Demo comments support a subset of Markdown (inline code, bold, italic, links, and lists), keeping them readable both on the command line (demo <function>) and in the HTML output.
  • Large classdefs, whose methods are grouped with banner comment blocks, are rendered with one collapsible block per method group on the main page and a standalone page per method, each carrying a class-scoped sidebar and breadcrumb navigation.
  • Ordinary classdefs and functions are rendered as before.
  • Updated the README documentation guidelines for texinfo, classdefs, and demos.

pkg-octave-doc-0.7.0

Choose a tag to compare

@pr0m1th3as pr0m1th3as released this 07 Jul 23:56
  • Self-contained texinfo parser, featuring most usable texinfo tags.
  • Dropped dependency on the texi2html v1.82 legacy command line tool.
  • 10-fold speed increase in package documentation (measured on the datatypes package).

pkg-octave-doc-0.6.9

Choose a tag to compare

@pr0m1th3as pr0m1th3as released this 09 Dec 10:23
  • Use jsondecode to access package information from packages.json file.
  • Fix classdef_texi2html to include methods that contain the class name in their name.

pkg-octave-doc-0.6.8

Choose a tag to compare

@pr0m1th3as pr0m1th3as released this 15 Oct 15:43
  • Allow searching for alternative package icon name using the repo's root directory.

pkg-octave-doc-0.6.7

Choose a tag to compare

@pr0m1th3as pr0m1th3as released this 28 Sep 20:07
  • Fix find_GHurls to use a separate temp directory for package extraction to avoid conflicts.
  • Use consistent typography for Octave code and variables throughout the documentation.
  • Further improvements on the layout for classdef documentation pages.

pkg-octave-doc-0.6.6

Choose a tag to compare

@pr0m1th3as pr0m1th3as released this 27 Sep 18:09
  • Improve layout for classdef documentation pages.

pkg-octave-doc-0.6.5

Choose a tag to compare

@pr0m1th3as pr0m1th3as released this 26 Sep 06:20
  • Replace HTML reserved characters < and > with their respective entity names in demo code blocks.

pkg-octave-doc-0.6.4

Choose a tag to compare

@pr0m1th3as pr0m1th3as released this 07 Aug 19:14
  • Remove duplication of first sentence in classdef properties and methods from help text body.