Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ sphinx_docs(
":bzl_api_docs",
":py_api_srcs",
":py_runtime_pair",
"@sphinxdocs//sphinxdocs/docs:docs_lib",
"@sphinxdocs//docs:docs_lib",
],
)

Expand Down
2 changes: 1 addition & 1 deletion sphinxdocs/.bazelrc.deleted_packages
Original file line number Diff line number Diff line change
@@ -1 +1 @@
common --deleted_packages=sphinxdocs/integration_tests/bcr
common --deleted_packages=integration_tests/bcr
File renamed without changes.
File renamed without changes.
23 changes: 23 additions & 0 deletions sphinxdocs/integration_tests/bcr/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
load("@bazel_skylib//rules:build_test.bzl", "build_test")
load("@sphinxdocs//sphinxdocs:sphinx.bzl", "sphinx_build_binary", "sphinx_docs")

sphinx_docs(
name = "docs",
srcs = ["index.md"],
config = "conf.py",
formats = ["html"],
sphinx = ":sphinx-build",
)

sphinx_build_binary(
name = "sphinx-build",
deps = [
"@dev_pip//myst_parser",
"@dev_pip//sphinx",
],
)

build_test(
name = "docs_build_test",
targets = [":docs"],
)
30 changes: 30 additions & 0 deletions sphinxdocs/integration_tests/bcr/MODULE.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
module(
name = "sphinxdocs_example",
version = "0.0.0",
)

bazel_dep(name = "sphinxdocs", version = "0.0.0")
local_path_override(
module_name = "sphinxdocs",
path = "../..",
)

bazel_dep(name = "rules_python", version = "0.0.0")
local_path_override(
module_name = "rules_python",
path = "../../..",
)

dev_pip = use_extension(
"@rules_python//python/extensions:pip.bzl",
"pip",
dev_dependency = True,
)
dev_pip.parse(
hub_name = "dev_pip",
python_version = "3.11",
requirements_lock = "@rules_python//docs:requirements.txt",
)
use_repo(dev_pip, "dev_pip")

bazel_dep(name = "bazel_skylib", version = "1.8.2")
6 changes: 5 additions & 1 deletion sphinxdocs/sphinxdocs/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ load("@bazel_skylib//rules:common_settings.bzl", "bool_flag")
load("//sphinxdocs/private:sphinx.bzl", "repeated_string_list_flag")

package(
default_visibility = ["//sphinxdocs:__subpackages__"],
default_visibility = ["//:__subpackages__"],
)

# Additional -D values to add to every Sphinx build.
Expand All @@ -44,23 +44,27 @@ bool_flag(
bzl_library(
name = "sphinx_bzl",
srcs = ["sphinx.bzl"],
visibility = ["//visibility:public"],
deps = ["//sphinxdocs/private:sphinx_bzl"],
)

bzl_library(
name = "sphinx_docs_library_bzl",
srcs = ["sphinx_docs_library.bzl"],
visibility = ["//visibility:public"],
deps = ["//sphinxdocs/private:sphinx_docs_library_macro_bzl"],
)

bzl_library(
name = "sphinx_stardoc_bzl",
srcs = ["sphinx_stardoc.bzl"],
visibility = ["//visibility:public"],
deps = ["//sphinxdocs/private:sphinx_stardoc_bzl"],
)

bzl_library(
name = "readthedocs_bzl",
srcs = ["readthedocs.bzl"],
visibility = ["//visibility:public"],
deps = ["//sphinxdocs/private:readthedocs_bzl"],
)
7 changes: 0 additions & 7 deletions sphinxdocs/sphinxdocs/integration_tests/bcr/BUILD.bazel

This file was deleted.

16 changes: 0 additions & 16 deletions sphinxdocs/sphinxdocs/integration_tests/bcr/MODULE.bazel

This file was deleted.

2 changes: 1 addition & 1 deletion sphinxdocs/sphinxdocs/private/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ load("@rules_python//python:py_binary.bzl", "py_binary")
load("@rules_python//python:py_library.bzl", "py_library")

package(
default_visibility = ["//sphinxdocs:__subpackages__"],
default_visibility = ["//:__subpackages__"],
)

# These are only exported because they're passed as files to the @sphinxdocs
Expand Down
Empty file added sphinxdocs/tests/__init__.py
Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@

from absl.testing import absltest
from google.protobuf import text_format
from stardoc.proto import stardoc_output_pb2

from sphinxdocs.private import proto_to_markdown
from stardoc.proto import stardoc_output_pb2

_EVERYTHING_MODULE = """\
module_docstring: "MODULE_DOC_STRING"
Expand Down
Empty file.
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import importlib.resources
from xml.etree import ElementTree

import tests.sphinx_stardoc as sphinx_stardoc
from absl.testing import absltest, parameterized

from sphinxdocs.tests import sphinx_stardoc


class SphinxOutputTest(parameterized.TestCase):
def setUp(self):
Expand Down