Releases: bazelbuild/skydoc
0.3.0
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.
- Building a
- 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
-
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
'sskydoc_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
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
0.1.2
0.1.1
Fixes:
- Re-allow macro-only bzl, fix runtime failure
0.1.0
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
- Bump protobuf dependency version to ed87c1f to fix python build issue on systems with protobuf installed locally.
- Support
.bzl
files withload()
statements - Fixes and improvements to generated Markdown.
0.0.4
- Make it possible to overwrite
skydoc
attribute of skylark_doc rule - Add workspace name and fix runfiles lookup
0.0.3
New Features
- Add support for documenting examples
- Add support for documenting output targets
Other Changes
- Remove dependency on Bazel's build.proto