Skip to content

Build documentation with Bazel #529

@nahueespinosa

Description

@nahueespinosa

Feature description

Currently, we rely on a Makefile and scripts to generate documentation. These tools have a list of Python requirements and system dependencies. Bazel can probably do a better job in terms of dependency tracking and incremental changes without having to spin up a container to generate docs.

Implementation considerations

rules_python comes with rules to generate sphinx docs: https://rules-python.readthedocs.io/en/latest/sphinxdocs/index.html#

While it is primarily oriented towards docgen for Starlark code, the core of it is agnostic as to what is being documented.

EDIT: The clanky bits have more to do with doxygen than make.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions