https://github.com/bazelbuild/stardoc

Stardoc: Starlark Documentation Generator
https://github.com/bazelbuild/stardoc

Last synced: 2 months ago
JSON representation

Stardoc: Starlark Documentation Generator

• Host: GitHub
• URL: https://github.com/bazelbuild/stardoc
• Owner: bazelbuild
• License: apache-2.0
• Created: 2019-09-11T13:32:57.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-05T16:13:04.000Z (4 months ago)
• Last Synced: 2024-02-05T17:33:04.488Z (4 months ago)
• Language: Starlark
• Homepage:
• Size: 94.8 MB
• Stars: 96
• Watchers: 15
• Forks: 39
• Open Issues: 50
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS
  • Authors: AUTHORS

Lists

• awesome-bazel - Stardoc - Starlark documentation generator (Tooling / Starlark)

README

        
# Stardoc - Starlark Documentation Generator

[![Build status](https://badge.buildkite.com/d8594eb71e4869c792cce22428b08e03b345f9c65dc603d70b.svg?branch=master)](https://buildkite.com/bazel/stardoc)

Stardoc is a documentation generator for [Bazel](https://bazel.build) build rules

written in [Starlark](https://bazel.build/docs/skylark/index.html).

Stardoc provides a Starlark rule (`stardoc`, see [documentation](docs/stardoc_rule.md)) that can

be used to build documentation for Starlark rules in Markdown. Stardoc generates one documentation

page per `.bzl`file.

## Get Started

* How to [set up Stardoc for your project](docs/getting_started_stardoc.md)

* Writing [docstrings](docs/writing_stardoc.md)

* How to [integrate Stardoc with your build](docs/generating_stardoc.md).

* See also [Advanced Topics](docs/advanced_stardoc_usage.md).

## About Stardoc

* Stardoc [rule reference](docs/stardoc_rule.md).

* How to [contribute to Stardoc](docs/contributing.md)

## Project Status

### Skydoc deprecation

Stardoc is a replacement for the **deprecated** "Skydoc" documentation generator.

See [Skydoc Deprecation](docs/skydoc_deprecation.md) for

details on the deprecation and migration details.

### Future plans

See our [future plans](docs/future_plans.md) for refactoring Stardoc to be more consistent with how Bazel evaluates .bzl files, and what it means for maintenance of this project.

### Maintainer's guide

See the [maintaner's guide](docs/maintainers_guide.md) for instructions for

cutting a new release.