Lines Matching full:sphinx

15 """Implementation of sphinx rules."""
28     doc = "Information about source tree for Sphinx to build.",
44     doc = "Information for running the underlying Sphinx command directly",
58         "sphinx": """
61 The sphinx-build binary to run.
66 Additional tools Sphinx needs
72     """Create an executable with the sphinx-build command line interface.
74     The `deps` must contain the sphinx library and any other extensions Sphinx
78         name: {type}`str` name of the target. The name "sphinx-build" is the
79             conventional name to match what Sphinx itself uses.
101         sphinx,
108     """Generate docs using Sphinx.
112       format Sphinx creates. This target also has a separate output
117     * `<name>.run`: A binary that directly runs the underlying Sphinx command
122         srcs: {type}`list[label]` The source files for Sphinx to process.
124         renamed_srcs: {type}`dict[label, dict]` Doc source files for Sphinx that
127         sphinx: {type}`label` the Sphinx tool to use for building
128             documentation. Because Sphinx supports various plugins, you must
131             any executable supporting the `sphinx-build` command line interface
133         config: {type}`label` the Sphinx config file (`conf.py`) to use.
138             Sphinx see `foo.md` in its generated source directory. If not
140         extra_opts: {type}`list[str]` Additional options to pass onto Sphinx building.
143         tools: {type}`list[label]` Additional tools that are used by Sphinx and its plugins.
144             This just makes the tools available during Sphinx execution. To locate
164         sphinx = sphinx,
225             sphinx = ctx.attr.sphinx,
236             doc = "Additional options to pass onto Sphinx. These are added after " +
239         "formats": attr.string_list(doc = "Output formats for Sphinx to create."),
241             doc = "Directory of files for Sphinx to process.",
244         "sphinx": attr.label(
248             doc = "Sphinx binary to generate documentation.",
252             doc = "Additional tools that are used by Sphinx and its plugins.",
306         executable = ctx.executable.sphinx,
312         progress_message = "Sphinx building {} for %{{label}}".format(format),
318     # Sphinx only accepts a single directory to read its doc sources from.
332             progress_message = "Symlinking Sphinx source %{input} to %{output}",
337     # Though Sphinx has a -c flag, we move the config file into the sources
387             doc = "Config file for Sphinx",
394             doc = "Doc source files for Sphinx that are renamed. This is " +
400             doc = "Doc source files for Sphinx.",
421     The Sphinx inventory format isn't formally documented, but is understood
425     # Sphinx inventory version 2
513     sphinx = run_info.sphinx
522             "%SPHINX_EXEC_PATH%": sphinx[DefaultInfo].files_to_run.executable.path,
523             "%SPHINX_RUNFILES_PATH%": sphinx[DefaultInfo].files_to_run.executable.short_path,
529     ).merge(sphinx[DefaultInfo].default_runfiles).merge_all([
543 Directly run the underlying Sphinx command `sphinx_docs` uses.
546 Sphinx command so that debuggers can be attached or output more directly