search

Brightspace / rules_csharp

Bazel rules for C#
Apache License 2.0
8 stars 5 forks source link

Generate the APIReference using Stardoc #110

Closed jrbeverly closed 4 years ago

jrbeverly commented 4 years ago

Add support for stardoc into our bazel rules. This allows us to build the docs using bazel build //docs/... or using the helper script update-docs.sh.

This PR adds the ability to compile an API Reference for our bazel rules, based on the index for docs (csharp/defs.for_docs.bzl). Splitting this from the usage index (defs.bzl) helps avoid mixing the docs and compilation based actions, which at the moment is useful as providers.bzl is causing some issues.

I have noticed an issue where any file that relies (loads) providers.bzl cannot be compiled with stardoc. Although it can be compiled on its own (if the header comment is removed), I think it'll require a bit more investigation to determine exactly why this isn't working as intended.

Resolves #17

jrbeverly commented 4 years ago

This is a preview of what the rendered markdown looks like for the stardoc.

j3parker commented 4 years ago

Cool!