Avoid displaying arguments when a doc-comment is already in place.
by @hsjobeki;
- 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.
- 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 nix-community#91.
Removed due to invalid lock file.
-
Added support to customise the attribute set prefix, which was previously hardcoded to
lib
. The default is stilllib
, but you can pass--prefix
now to use something else likeutils
.By @Janik-Haag in nix-community#97
-
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 nix-community#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.
- readme: fix link to rendering example by @infinisil in nix-community#67
- Fix indentation of structured multi-line comments by @asymmetric in nix-community#81
- Fix line indentation stripping by @infinisil in nix-community#62
- nix: remove outdated outputHashes by @asymmetric in nix-community#38
- add snapshot testing by @asymmetric in nix-community#39
- Create dependabot.yml by @asymmetric in nix-community#41
- chore(deps): bump cachix/install-nix-action from 20 to 22 by @dependabot in nix-community#42
- complete the markdown transition by @pennae in nix-community#40
- Update rnix to 0.11 by @pennae #36
- Correctly support nested identifiers by @infinisil #27
- Switched output format from DocBook to CommonMark by @ryantm #25