bazelbuild/stardoc

Stars
107
Rank 323,587 (Top 7 %)
Language
Java
License
Apache License 2.0
Created about 5 years ago
Updated 2 months ago

bazelbuild/stardoc

bazelbuild

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Stardoc: Starlark Documentation Generator

Stardoc - Starlark Documentation Generator

Stardoc is a documentation generator for Bazel build rules written in Starlark.

Stardoc provides a Starlark rule (stardoc, see documentation) that can be used to build documentation for Starlark rules in Markdown. Stardoc generates one documentation page per .bzlfile.

Get Started

How to set up Stardoc for your project
Writing docstrings
How to integrate Stardoc with your build.
See also Advanced Topics.

About Stardoc

Stardoc rule reference.
How to contribute to Stardoc

Project Status

Skydoc deprecation

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

See Skydoc Deprecation for details on the deprecation and migration details.

Future plans

See our future plans 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 for instructions for cutting a new release.

bazel

a fast, scalable, multi-language and extensible build system

starlark

Starlark Language

bazelisk

A user-friendly launcher for Bazel.

rules_go

Go rules for Bazel

bazel-gazelle

Gazelle is a Bazel build file generator for Bazel projects. It natively supports Go and protobuf, and it may be extended to support new languages and custom rule sets.

rules_docker

Rules for building and handling Docker images with Bazel

buildtools

A bazel BUILD file formatter and editor

examples

Examples for Bazel

intellij

IntelliJ plugin for Bazel projects

rules_rust

Rust rules for Bazel

bazel-buildfarm

Bazel remote caching and execution service

tulsi

An Xcode Project Generator For Bazel

rules_python

Bazel Python Rules

rules_apple

Bazel rules to build apps for Apple platforms.

bazel-watcher

Tools for building Bazel targets when source files change.

bazel-skylib

Common useful functions and rules for Bazel

sandboxfs

A virtual file system for sandboxing

rules_scala

Scala rules for Bazel

rules_kotlin

Bazel rules for Kotlin

remote-apis

An API for caching and execution of actions on a remote system.

rules_swift

Bazel rules to build Swift on Apple and Linux platforms

rules_k8s

This repository contains rules for interacting with Kubernetes configurations / clusters.

rules_typescript

MOVED to https://github.com/bazelbuild/rules_nodejs/tree/3.x/third_party/github.com/bazelbuild/rules_typescript

continuous-integration

Bazel's Continuous Integration Setup

bazel-central-registry

The central registry of Bazel modules for the Bzlmod external dependency system.

rules_pkg

Bazel rules for creating packages of many types (zip, tar, deb, rpm, ...)

rules_cc

C++ Rules for Bazel

bazel-toolchains

Repository that hosts Bazel toolchain configs for remote execution and related support tools.

rules_android

Android rules for Bazel

rules_proto

Protocol buffer rules for Bazel

rules_closure

Closure rules for Bazel

vim-bazel

Vim support for Bazel

platforms

Constraint values for specifying platforms and toolchains

proposals

Index of all Bazel proposals and design documents

rules_webtesting

Bazel rules to allow testing against a browser with WebDriver.

apple_support

Apple support for Bazel rules

emacs-bazel-mode

Emacs mode for Bazel

rules_license

rules_java

Java rules for Bazel

reclient

setup-bazelisk

Set up your GitHub Actions workflow with a specific version of Bazelisk

rules_sass

Sass rules for Bazel

remote-apis-sdks

This repository contains client libraries for the Remote Execution API https://github.com/bazelbuild/remote-apis

bazel-federation

skydoc

Documentation generator for Skylark

migration-tooling

Migration tools for Bazel

codelabs

BUILD_file_generator

Generate BUILD files for your Java files

eclipse

Eclipse For Bazel (deprecated, see https://github.com/salesforce/bazel-eclipse instead)

bazel-integration-testing

Framework for integration tests that call Bazel

rules_appengine

AppEngine rules for Bazel

rules_android_ndk

tools_remote

bazel-bench

Benchmarking tool for bazel

vim-ft-bzl

rules_perl

Perl rules for Bazel

tools_android

Tools for use with building Android apps with Bazel

homebrew-tap

This repository contains a collection of Homebrew (aka, Brew) "formulae" for Bazel

rules_d

D rules for Bazel

bazel-blog

Content of the Bazel blog

bzlmod

rules_testing

Starlark testing framework and utility libraries

rules_gwt

Bazel rules for GWT

bazel-website

Website for Bazel, a fast, scalable, multi-language and extensible build system

bazelcon

Artifacts from BazelCon

java_tools

rules_groovy

Groovy rules for Bazel

rules_postcss

PostCSS rules for Bazel

rules_platform

bazel_metrics

community

Resources for community management efforts, such as SIGs

rules_angular

OBSOLETE see https://github.com/angular/angular/tree/master/packages/bazel

gmaven_rules

This repository is deprecated. Please instead use https://github.com/bazelbuild/rules_jvm_external

rules_utp

.allstar

.github

bazel-worker-api

build-event-stream

rules_sh