Skip to content

Releases: nix-community/nixdoc

v3.0.2

12 Mar 00:20
a187d87
Compare
Choose a tag to compare

What's Changed

  • Update dependencies in #104

  • Avoid displaying arguments when a doc-comment is already in place.

    by @hsjobeki in #109.

Full Changelog: v3.0.1...v3.0.2

v3.0.1

27 Feb 18:41
Compare
Choose a tag to compare

What's Changed

New Features

  • Official Doc-Comments Support: We've introduced support for official doc-comments as defined in RFC145. This enhancement aligns nixdoc with our latest documentation standard.

Deprecated Features

  • Legacy Custom Format: The custom nixdoc format is now considered a legacy feature. We plan to phase it out in future versions to streamline documentation practices.
  • We encourage users to transition to the official doc-comment format introduced in this release.
  • For now we will continue to maintain the legacy format, but will not accept new features or enhancements for it. This decision allows for a period of transition to the new documentation practices.

See Migration guide for smooth transition

by @hsjobeki; co-authored by @mightyiam

in #91.

New Contributors

Full Changelog: v2.7.0...v3.0.0

v3.0.0

27 Feb 18:33
Compare
Choose a tag to compare

Removed due to invalid lock file. Use v3.0.1 instead

v2.7.0

13 Dec 19:05
2def30e
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v2.6.0...v2.7.0

v2.6.0

18 Nov 22:30
93ca893
Compare
Choose a tag to compare

What's Changed

  • After doing a great job of maintaining the project for this year, @asymmetric is passing on the torch to @infinisil!

  • Multi-line comments at the top of the file now become the section description text.
    By @phaer in #70

    For example, the following file

    /*
    This is just a test!
    */
    {
      /* Increments a number by one */
      increment = x: x + 1;
    }

    turns into the following markdown:

    # Test {#sec-functions-library-test}
    This is just a test!
    
    ## `lib.test.increment` {#function-library-lib.test.increment}
    
    Increments a number by one
    
    `x`
    
    : Function argument

    whereas before, the top section would've been empty.

New Contributors

  • @phaer made their first contribution in #70

Full Changelog: v2.5.1...v2.6.0

v2.5.1

02 Nov 14:24
Compare
Choose a tag to compare

What's Changed

Full Changelog: v2.4.0...v2.5.1

v2.4.0

29 Jul 12:11
5d37156
Compare
Choose a tag to compare

What's Changed

Full Changelog: v2.3.0...v2.4.0

v2.3.0

01 Jul 18:34
Compare
Choose a tag to compare

What's Changed

Full Changelog: v2.2.0...v2.3.0