Skip to content

Documentation of repository rules have unparsed Markdown #11428

@Wyverald

Description

@Wyverald

Example: https://docs.bazel.build/versions/master/repo/http.html#http_archive-patches

This is due to Stardoc generating an HTML table around attribute documentation, which means that any Markdown inside is not parsed. Most other Starlark functions seems to use HTML for attribute documentation.

There are two ways we could fix this:

  1. Just change //tools/build_defs/repo/http.bzl to use HTML tags (e.g. <code>) instead of Markdown (e.g. `).
  2. Plug in a Mardown parser that supports Markdown tables into Jekyll, and then update Stardoc to generate Markdown tables instead of HTML tables. This would allow us to use Markdown in attribute documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P4This is either out of scope or we don't have bandwidth to review a PR. (No assignee)staleIssues or PRs that are stale (no activity for 30 days)team-DocumentationDocumentation improvements that cannot be directly linked to other team labelsteam-Starlark-IntegrationIssues involving Bazel's integration with Starlark, excluding builtin symbolstype: documentation (cleanup)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions