Skip to content

Create decision record: drive extensions through bazel? #260

@AlexanderLanin

Description

@AlexanderLanin

Currently our sphinx extensions access docs-external data directly. For example:

  • parsing source code to find referenced needs
  • parsing test results to map to needs
  • accessing github api to find PR reviewers

An alternative approach is to perform those activities before starting sphinx, and have sphinx operate on static data. This goes into the direction of making use of bazel caching.

On the other hand, this adds complexity. And even more importantly it couples docs generation to bazel, which many do not whish.

As both approaches have clearly several significant advantages, we want to write up a decision record which details them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Draft

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions