Skip to content

Commit

Permalink
Move doc generation tools to bazel distribution repository (#552)
Browse files Browse the repository at this point in the history
## Usage and product changes
Moves bazel rules used for generating documentation into the
vaticle/bazel-distribution repository

## Implementation
* Updates BUILD files to reflect moving converters for {doxygen,
javadoc, sphinx (python), rustdocs} into bazel-distribution

PR chain: #552 > typedb/typedb-dependencies#491 >
typedb/bazel-distribution#393
  • Loading branch information
krishnangovindraj authored Jan 12, 2024
1 parent fc9b4a0 commit 3841079
Show file tree
Hide file tree
Showing 11 changed files with 19 additions and 364 deletions.
22 changes: 11 additions & 11 deletions WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -123,17 +123,6 @@ sonarcloud_dependencies()
load("@vaticle_dependencies//tool/unuseddeps:deps.bzl", unuseddeps_deps = "deps")
unuseddeps_deps()

# Load //tool/docs
load("@vaticle_dependencies//tool/docs:python_deps.bzl", docs_deps = "deps")
docs_deps()
load("@vaticle_dependencies_tool_docs//:requirements.bzl", install_doc_deps = "install_deps")
install_doc_deps()

load("@vaticle_dependencies//tool/docs:java_deps.bzl", java_doc_deps = "deps")
java_doc_deps()
load("@google_bazel_common//:workspace_defs.bzl", "google_common_workspace_rules")
google_common_workspace_rules()

####################################
# Load @vaticle_bazel_distribution #
####################################
Expand All @@ -157,6 +146,17 @@ pip_deps()
load("@vaticle_bazel_distribution_pip//:requirements.bzl", install_pip_deps = "install_deps")
install_pip_deps()

# Load //docs
load("@vaticle_bazel_distribution//docs:python/deps.bzl", docs_deps = "deps")
docs_deps()
load("@vaticle_dependencies_tool_docs//:requirements.bzl", install_doc_deps = "install_deps")
install_doc_deps()

load("@vaticle_bazel_distribution//docs:java/deps.bzl", java_doc_deps = "deps")
java_doc_deps()
load("@google_bazel_common//:workspace_defs.bzl", "google_common_workspace_rules")
google_common_workspace_rules()

######################################
# Load @vaticle_typedb_driver_python #
######################################
Expand Down
3 changes: 2 additions & 1 deletion cpp/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,16 @@
load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
load("@vaticle_dependencies//builder/cpp:rules.bzl", "clang_format_test")
load("@vaticle_bazel_distribution//common:rules.bzl", "assemble_targz", "assemble_zip", "checksum", "assemble_versioned")
load("@vaticle_bazel_distribution//docs:cpp/rules.bzl", "doxygen_docs")
load("@vaticle_bazel_distribution//artifact:rules.bzl", "deploy_artifact")
load("@vaticle_dependencies//distribution:deployment.bzl", "deployment")
load("@rules_pkg//:pkg.bzl", "pkg_tar")
load("@rules_pkg//pkg:mappings.bzl", "pkg_files", "strip_prefix")
load("@vaticle_bazel_distribution//platform:constraints.bzl", "constraint_linux_arm64", "constraint_linux_x86_64",
"constraint_mac_arm64", "constraint_mac_x86_64", "constraint_win_x86_64")
load("//tool/docs:cpp/rules.bzl", "doxygen_docs", "doxygen_to_adoc")
load(":build_opts.bzl", "cxxopts")
load("//cpp:docs_structure.bzl", "dir_mapping")
load("//tool/docs:cpp/rules.bzl", "doxygen_to_adoc")

pkg_files(
name = "typedb-driver-cpp-headers",
Expand Down
2 changes: 1 addition & 1 deletion dependencies/vaticle/repositories.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def vaticle_dependencies():
git_repository(
name = "vaticle_dependencies",
remote = "https://github.com/vaticle/dependencies",
commit = "41bb5bfb1b5f2adab4a88886d2e74f10d456e7e1", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies
commit = "1d4919aa905a180dbe97b145d6861881893724e9", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies
)

def vaticle_typedb_common():
Expand Down
2 changes: 1 addition & 1 deletion nodejs/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ load("@aspect_rules_js//npm:defs.bzl", "npm_link_package", "npm_package")
load("@aspect_bazel_lib//lib:jq.bzl", "jq")
load("@npm//:defs.bzl", "npm_link_all_packages")
load("//nodejs:tool/typedoc/rules.bzl", "typedoc_docs")
load("//tool/docs:nodejs/rules.bzl", "typedoc_to_adoc")
load("//nodejs:docs_structure.bzl", "dir_mapping")
load("//tool/docs:nodejs/rules.bzl", "typedoc_to_adoc")

npm_link_all_packages(
name = "node_modules",
Expand Down
8 changes: 3 additions & 5 deletions python/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@
# under the License.
#

load("@vaticle_bazel_distribution//docs:python/rules.bzl", "sphinx_docs")
load("@vaticle_dependencies//builder/swig:python.bzl", "py_native_lib_rename")
load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
load("//python/tool/sphinx:rules.bzl", "sphinx_docs")
load("//tool/docs:python/rules.bzl", "sphinx_to_adoc")
load("//python:docs_structure.bzl", "dir_mapping")

load("//python:rules.bzl", "native_driver_versioned")
load("//python:python_versions.bzl", "python_versions")
load("//python:docs_structure.bzl", "dir_mapping")
load("//tool/docs:python/rules.bzl", "sphinx_to_adoc")

native_driver_versioned(python_versions = python_versions)

Expand Down Expand Up @@ -77,7 +76,6 @@ checkstyle_test(
"WORKSPACE",
"requirements*.txt",
"typedb/**/*",
"tool/sphinx/*",
]),
exclude = glob([
"conf.py",
Expand Down
42 changes: 0 additions & 42 deletions python/tool/sphinx/BUILD

This file was deleted.

84 changes: 0 additions & 84 deletions python/tool/sphinx/rules.bzl

This file was deleted.

37 changes: 0 additions & 37 deletions python/tool/sphinx/sphinx_html_builder.py

This file was deleted.

2 changes: 1 addition & 1 deletion rust/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ load("@vaticle_dependencies//builder/rust:rules.bzl", "rust_cbindgen")
load("@vaticle_dependencies//builder/swig:java.bzl", "swig_java")
load("@vaticle_dependencies//distribution:deployment.bzl", "deployment")
load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
load("//tool/docs:rust/rules.bzl", "rust_docs", "rustdoc_to_adoc")
load("//rust:docs_structure.bzl", "dir_mapping")
load("//tool/docs:rust/rules.bzl", "rust_docs", "rustdoc_to_adoc")

typedb_driver_srcs = glob(["src/**/*.rs"])
typedb_driver_tags = ["crate-name=typedb-driver"]
Expand Down
100 changes: 0 additions & 100 deletions tool/docs/cpp/doxyfile.template

This file was deleted.

Loading

0 comments on commit 3841079

Please sign in to comment.