Add the posibility to run `bst doc` to generate the documentation for the bst tree
- Dominant language
- Python
- Stars
- 140
- Forks
- 45
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 6
Description
[See original issue on GitLab](https://gitlab.com/BuildStream/buildstream/-/issues/1356)
In GitLab by [[Gitlab user @tcanabrava]](https://gitlab.com/tcanabrava) on Jul 8, 2020, 11:43
Quite a few of the buildstream projects are `meta` projects that are supposed to be integrated to other projects, but those projects defines variables that should be set, or specific intrinsics that are not easily discoverable unless you download the meta projet and open the files to understand what's missing.
I'ts important to have a de-facto way to produce documentation for meta-projects.
Contributor guide
Research direction
Start by tracing the existing bst command entry point and how BuildStream projects expose variables and intrinsics. Define what `bst doc` should discover and generate for meta-projects, then verify that the resulting documentation makes required variables and intrinsics discoverable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100