rules_sphinx

Rules for building Sphinx documentation with Bazel.

WORKSPACE

To incorporate rules_sphinx into your project at the following to your WORKSPACE file.

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "rules_sphinx",
    # See release page for latest version url and sha.
)

load("@rules_sphinx//sphinx:direct_repositories.bzl", "rules_sphinx_direct_deps")
rules_sphinx_direct_deps()

load("@rules_sphinx//sphinx:indirect_repositories.bzl", "rules_sphinx_indirect_deps")
rules_sphinx_indirect_deps()

Rules

• sphinx_html_gen - Generates HTML documentation into [NAME]_html directory.
• sphinx_view - Given an HTML generator, create target to launch viewer.
• sphinx_html - A macro that creates a sphinx_html_gen and an associated sphinx_view with the [NAME].view verb.

Examples

To build the test documentation use:

bazel build @rules_sphinx//test/root_dir:test_docs

To build and view test documentation use:

bazel run @rules_sphinx//test/root_dir:test_docs.view