There is a use case to create a complete, nice looking documentation out of a bazel workspace, targets, rules, ...
So the goal is to get one/multiple .rst-documents, which contains headlines, text, bazel:xy output and maybe tables for attributes. These rst documents can then be integrated into each sphinx project.
This feature would provide a more readable, better structured output as autobazel-workspace can give, as it creates output row by row only (no tables or headlines).
Main focus is to document found targets (.bzl-fies).
For each target a rst-file shall be created.
Spec:
provide a command line command bazelreport
takes as first argument location to document or path with wildcards
has additional parameters:
-w: document workspace (if found)
-p: document packages (if found)
-r: recursive (enter subfolders)
-s: single file (everything in one rst file)
Examples:
bazelreport /bazel/workspace_1
-> creates rst file if bzw files are found
bazelreport -r -s /bazel/workspace_1/package/*_python.bzl
-> documents all _python.bzl files find in subfolder of .../package/ in a single rst file
There is a use case to create a complete, nice looking documentation out of a bazel workspace, targets, rules, ...
So the goal is to get one/multiple .rst-documents, which contains headlines, text, bazel:xy output and maybe tables for attributes. These rst documents can then be integrated into each sphinx project.
This feature would provide a more readable, better structured output as
autobazel-workspacecan give, as it creates output row by row only (no tables or headlines).Main focus is to document found targets (.bzl-fies). For each target a rst-file shall be created.
Spec:
bazelreportExamples: