0.5.2

Bugfix release: fixes crash with config_common.toolchain_type.

Contributors

Alexandre Rostovtsev, Keith Smiley

WORKSPACE setup

To use Stardoc, add the following to your WORKSPACE file:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "io_bazel_stardoc",
    sha256 = "05fb57bb4ad68a360470420a3b6f5317e4f722839abc5b17ec4ef8ed465aaa47",
    urls = [
        "https://mirror.bazel.build/github.com/bazelbuild/stardoc/releases/download/0.5.2/stardoc-0.5.2.tar.gz",
        "https://github.com/bazelbuild/stardoc/releases/download/0.5.2/stardoc-0.5.2.tar.gz",
    ],
)

load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")

stardoc_repositories()

0.5.1

Bugfix release: minor fixes, including a fix for build failure due to missing zlib version.

Contributors

aiuto, Alexandre Rostovtsev, Brian Silverman, Casey, Xùdōng Yáng

WORKSPACE setup

To use Stardoc, add the following to your WORKSPACE file:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "io_bazel_stardoc",
    sha256 = "aa814dae0ac400bbab2e8881f9915c6f47c49664bf087c409a15f90438d2c23e",
    urls = [
        "https://mirror.bazel.build/github.com/bazelbuild/stardoc/releases/download/0.5.1/stardoc-0.5.1.tar.gz",
        "https://github.com/bazelbuild/stardoc/releases/download/0.5.1/stardoc-0.5.1.tar.gz",
    ],
)

load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")

stardoc_repositories()

The load statement and function call after the io_bazel_stardoc repository
definition ensure that this repository's dependencies are loaded.

Using the rules

See the source.

0.5.0

This release includes many fixes for Stardoc's markdown output, plus:

New Features

• Raw protobuf output via format = "proto" (#20)
• Stardoc now outputs documentation for macro returns and deprecations (#75)
  as well as module (file) docstrings (#100)

Contributors

Alexandre Rostovtsev, Alex Eagle, Andrew Z Allen, Chris Rebert, c-parsons, Ivo
List, Jon Brandvein, Laurent Le Brun, Max Vorobev, pbatg, Philipp Wollermann,
Samuel Giddins, Thomas Van Lenten, Tiago Quelhas, Xùdōng Yáng, Yiting Wang

WORKSPACE setup

To use Stardoc, add the following to your WORKSPACE file:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "io_bazel_stardoc",
    sha256 = "c9794dcc8026a30ff67cf7cf91ebe245ca294b20b071845d12c192afe243ad72",
    urls = [
        "https://mirror.bazel.build/github.com/bazelbuild/stardoc/releases/download/0.5.0/stardoc-0.5.0.tar.gz",
        "https://github.com/bazelbuild/stardoc/releases/download/0.5.0/stardoc-0.5.0.tar.gz",
    ],
)

load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")

stardoc_repositories()

The load statement and function call after the io_bazel_stardoc repository
definition ensure that this repository's dependencies are loaded.

Using the rules

See the source.

0.4.0

First release of Stardoc under the new repository location bazelbuild/stardoc. Please use this repository for future Stardoc releases instead of its old location. See Getting Started for updated setup information.

There are many new features since the last release. A summary of major features:

• Changed the default Stardoc output format to use pure-markdown tables instead of HTML tables. This output format is fully compatible with markdown formatting constructs. For example, use **bold** instead of <b>bold</b>. The <. and > characters are escaped in this output format.
• Stardoc now supports custom formatting. See Custom Output documentation for details.
• aspect() definitions are now documented by Stardoc.
• Module definitions (structs which combine series of functions in a 'namespace') are now documetned by Stardoc.
• Attribute default-value information is now included in output.

Huge Thanks to kendalllaneee and blossommojekwu for their work on many of the features in this release.

WORKSPACE setup

To use Stardoc, add the following to your WORKSPACE file:

load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")

git_repository(
    name = "io_bazel_stardoc",
    remote = "https://github.com/bazelbuild/stardoc.git",
    tag = "0.4.0",
)

load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")
stardoc_repositories()

The load statement and function call after the io_bazel_stardoc repository
definition ensure that this repository's dependencies are loaded.