xref: /aosp_15_r20/external/bazelbuild-rules_python/sphinxdocs/private/sphinx_docs_library_info.bzl (revision 60517a1edbc8ecf509223e9af94a7adec7d736b8) 
1"""Provider for collecting doc files as libraries."""
2
3SphinxDocsLibraryInfo = provider(
4    doc = "Information about a collection of doc files.",
5    fields = {
6        "files": """
7:type: depset[File]
8
9The documentation files for the library.
10""",
11        "prefix": """
12:type: str
13
14Prefix to prepend to file paths in `files`. It is added after `strip_prefix`
15is removed.
16""",
17        "strip_prefix": """
18:type: str
19
20Prefix to remove from file paths in `files`. It is removed before `prefix`
21is prepended.
22""",
23        "transitive": """
24:type: depset[struct]
25
26Depset of transitive library information. Each entry in the depset is a struct
27with fields matching the fields of this provider.
28""",
29    },
30)
31