Skip to content
This repository has been archived by the owner on Sep 15, 2021. It is now read-only.

Releases: bazelbuild/skydoc

0.3.0

20 Mar 19:21
b8a32e0
Compare
Choose a tag to compare

Please note Skydoc is deprecated. Users should migrate to Stardoc.
See deprecation details and migration tips.
The Skydoc binary will be deleted in 0.4.0.

This release makes the following Stardoc improvements:

  • Stardoc releases with a prebuilt Jar instead of needing to be built from source. This means:
    • Building a stardoc target will be considerably faster.
    • Transitive Stardoc dependency requirements are far cleaner; users no longer need to depend on @com_google_protobuf or @io_bazel.
  • Support for documenting repository rules created with repository_rule()
  • Support for documenting “function modules” (structs of functions).
  • Stardoc no longer shows documentation of transitively-loaded symbols. Only symbols directly declared in the input file, or directly depended on by the input file, will be documented.
  • Fix documentation for **kwargs and *args function parameters
  • Support for documenting (or depending on) generated bzl input files
  • Fix bzl files which depend on other bzl files using the fully-qualified repository name.
  • Several rendering fixes (especially pertaining to href tags)

This release compatible with Bazel 0.23.2.

0.2.0

30 Nov 17:27
4ea7b82
Compare
Choose a tag to compare
  • Introduces Stardoc, a complete replacement for the old "Skydoc"` binary.
    See the documentation page for usage changes.
    Note that old "Skydoc" is still available, though it is deprecated and will be removed in a future release.

  • Overhaul skydoc repository loading steps. Loading skylark:skylark.bzl's skydoc_repositories is deprecated. Use :setup.bzl's `'skydoc_repositories' instead. See the documentation page for full usage details.

This release compatible with Bazel 0.19.2.

0.1.4

28 Nov 10:50
b36d22c
Compare
Choose a tag to compare

Major changes:

  • Only generate one "Overview" link in nav (#51)
  • Make skydoc compatible with the future versions of Bazel (#53)

Skylark library improvements:

  • Add relative_to_caller_repository param to Label stub. (#46)
  • Remove STRING_DICT_UNARY references (#47)
  • Rename set to depset (#52)
  • add attr.label_keyed_string_dict (fixes #54) (#55)
  • add boolean type to macro (#60)
  • add environ to repository_rule stub (#61)

Other fixes:

  • Update bazel.io references to bazel.build (#65)

0.1.3

13 Feb 09:32
Compare
Choose a tag to compare

Major changes:

  • Add site_root attribute for specifying site root url to prepend links (#42)

0.1.2

10 Feb 10:51
Compare
Choose a tag to compare
  • Update protobuf and rules_sass repositories (#39)
  • Implementing extracting symbols from load()s and adding them to stubs. (#38)
  • Update protobuf version (#40)
  • Update rules_sass dependency (#41)

0.1.1

15 Dec 01:09
Compare
Choose a tag to compare

Fixes:

  • Re-allow macro-only bzl, fix runtime failure

0.1.0

13 Dec 21:50
Compare
Choose a tag to compare

Major features

  • Generate documentation files in directories based on package structure
  • Generate overview page
  • Document default values for rule attributes

Improvements

  • Add stub for native module
  • Update parameters to attr... methods.
  • Do not generate page for .bzl file with no public rules.
  • Markdown format updates

0.0.5

16 Jun 16:32
Compare
Choose a tag to compare
  • Bump protobuf dependency version to ed87c1f to fix python build issue on systems with protobuf installed locally.
  • Support .bzl files with load() statements
  • Fixes and improvements to generated Markdown.

0.0.4

13 Jun 08:53
Compare
Choose a tag to compare
  • Make it possible to overwrite skydoc attribute of skylark_doc rule
  • Add workspace name and fix runfiles lookup

0.0.3

21 Apr 21:42
Compare
Choose a tag to compare

New Features

  • Add support for documenting examples
  • Add support for documenting output targets

Other Changes

  • Remove dependency on Bazel's build.proto