Skip to content

Add extra_srcs parameter to support literalinclude outside docs/ #514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tizava wants to merge 1 commit into from
Closed

Add extra_srcs parameter to support literalinclude outside docs/ #514

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ def _missing_requirements(deps):
fail(msg)
fail("This case should be unreachable?!")

def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good = None):
def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good = None, extra_srcs = []):
"""Creates all targets related to documentation.

By using this function, you'll get any and all updates for documentation targets in one place.
Expand All @@ -135,6 +135,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good =
data: Additional data files to include in the documentation build.
deps: Additional dependencies for the documentation build.
scan_code: List of code targets to scan for source code links.
extra_srcs: Additional source files to include in the Sphinx srcs (needed for literalinclude of files outside docs/).
Comment thread
tizava marked this conversation as resolved.
"""

call_path = native.package_name()
Expand Down Expand Up @@ -284,7 +285,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good =

sphinx_docs(
name = "needs_json",
srcs = [":docs_sources"],
srcs = [":docs_sources"] + extra_srcs,
config = ":" + source_prefix + "conf.py",
extra_opts = [
"-W",
Expand Down
Loading