Skip to content

Commit

Permalink
Switch from Skydoc to Stardoc (#181)
Browse files Browse the repository at this point in the history 
* Switch from Skydoc to Stardoc

Fixes: #177

* Let the documentation contain more up to date setup instructions

I'm not fully convinced that we should also document this as part of
jsonnet.bzl, but let's keep it in place for the time being.

* Remove the old Skydoc based documentation

Leave some placeholder pages in place that link to the new location.
  • Loading branch information
@EdSchouten
EdSchouten authored Apr 4, 2024
1 parent 36fdb4c commit 1839d26
Show file tree
Hide file tree
Showing 14 changed files with 489 additions and 769 deletions.
10 changes: 10 additions & 0 deletions .bazelci/presubmit.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ tasks:
build_targets:
- //...

docs:
name: docs
platform: ${{ platform }}
working_directory: docs
test_flags:
- --define
- jsonnet_port=${{ jsonnet_port }}
test_targets:
- //...

examples:
name: examples
platform: ${{ platform }}
Expand Down
1 change: 1 addition & 0 deletions .bazelignore
View file
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
docs
examples
1 change: 1 addition & 0 deletions MODULE.bazel
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ module(
repo_name = "io_bazel_rules_jsonnet",
)

bazel_dep(name = "bazel_skylib", version = "1.5.0")
bazel_dep(name = "jsonnet", version = "0.20.0")
bazel_dep(name = "jsonnet_go", version = "0.20.0", repo_name = "google_jsonnet_go")
35 changes: 0 additions & 35 deletions WORKSPACE
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
workspace(name = "io_bazel_rules_jsonnet")

load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")

local_repository(
name = "docs",
path = "docs",
)

load("//jsonnet:jsonnet.bzl", "jsonnet_repositories")

jsonnet_repositories()
Expand All @@ -18,31 +11,3 @@ jsonnet_go_repositories()
load("@google_jsonnet_go//bazel:deps.bzl", "jsonnet_go_dependencies")

jsonnet_go_dependencies(go_sdk_version = "1.17.8")

# Used for documenting Jsonnet rules.
# TODO: Move this to docs/WORKSPACE when recursive repositories are enabled.
git_repository(
name = "io_bazel_rules_sass",
remote = "https://github.com/bazelbuild/rules_sass.git",
commit = "a28d5ec04b32daef96299b22bb2fbd961c3febe6", # release 1.15.3
shallow_since = "1546636230 +0000"
)

load("@io_bazel_rules_sass//:package.bzl", "rules_sass_dependencies")

rules_sass_dependencies()

load("@io_bazel_rules_sass//:defs.bzl", "sass_repositories")

sass_repositories()

git_repository(
name = "io_bazel_skydoc",
remote = "https://github.com/bazelbuild/skydoc.git",
commit = "4ea7b8257d11ac33eef7e9daadbedbfe375d9236", # release 0.2.0
shallow_since = "1543532884 -0500",
)

load("@io_bazel_skydoc//skylark:skylark.bzl", "skydoc_repositories")

skydoc_repositories()
10 changes: 0 additions & 10 deletions docs/BUILD
View file

This file was deleted.

10 changes: 10 additions & 0 deletions docs/BUILD.bazel
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
load("@aspect_bazel_lib//lib:docs.bzl", "stardoc_with_diff_test", "update_docs")

stardoc_with_diff_test(
name = "jsonnet",
bzl_library_target = "@rules_jsonnet//jsonnet:jsonnet",
)

update_docs(
name = "update",
)
13 changes: 13 additions & 0 deletions docs/MODULE.bazel
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
module(
name = "docs",
version = "0.0.0",
)

bazel_dep(name = "aspect_bazel_lib", version = "2.7.0")
bazel_dep(name = "stardoc", version = "0.6.2")

bazel_dep(name = "rules_jsonnet", version = "0.5.0")
local_path_override(
module_name = "rules_jsonnet",
path = "..",
)
1 change: 0 additions & 1 deletion docs/WORKSPACE
View file

This file was deleted.

148 changes: 2 additions & 146 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,153 +1,9 @@


<!--
Documentation generated by Skydoc
-->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width initial-scale=1" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">

<title>Overview</title>

<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,600,700" type="text/css">
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<link rel="stylesheet" href="https://code.getmdl.io/1.1.1/material.green-light_blue.min.css">
<script defer src="https://code.getmdl.io/1.1.1/material.min.js"></script>
<link rel="stylesheet" href="https://bazelbuild.github.io/rules_jsonnet/main.css">
<title>rules_jsonnet documentation has moved</title>
</head>
<body>
<div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer
mdl-layout--fixed-header">
<header class="mdl-layout__header">
<div class="mdl-layout__header-row">
<span class="mdl-layout-title">Overview</span>
</div>
</header>
<div class="mdl-layout__drawer">
<span class="mdl-layout-title">Bazel</span>
<nav class="drawer-nav">
<ul class="drawer-nav">

<li><a href="https://bazelbuild.github.io/rules_jsonnet/index.html">Overview</a></li>
<li>
<a href="https://bazelbuild.github.io/rules_jsonnet/jsonnet/jsonnet.html">Jsonnet Rules</a>
<ul>
<li><a href="https://bazelbuild.github.io/rules_jsonnet/jsonnet/jsonnet.html#overview">Overview</a></li>
<li>
<a href="https://bazelbuild.github.io/rules_jsonnet/jsonnet/jsonnet.html#jsonnet_library">
jsonnet_library
</a>
</li>
<li>
<a href="https://bazelbuild.github.io/rules_jsonnet/jsonnet/jsonnet.html#jsonnet_to_json">
jsonnet_to_json
</a>
</li>
<li>
<a href="https://bazelbuild.github.io/rules_jsonnet/jsonnet/jsonnet.html#jsonnet_to_json_test">
jsonnet_to_json_test
</a>
</li>
</ul>
</li>

</ul>
</nav>
</div>

<main class="mdl-layout__content">
<div class="page-content">
<h1>Overview</h1>


<nav class="toc">
<h2>Rule sets</h2>
<ul>
<li><a href="#jsonnet">Jsonnet Rules</a></li>
</ul>
</nav>

<h2><a href="https://bazelbuild.github.io/rules_jsonnet/jsonnet/jsonnet.html">Jsonnet Rules</a></h2>

<h3>Rules</h3>
<table class="overview-table">
<colgroup>
<col class="col-name" />
<col class="col-description" />
</colgroup>
<tbody>
<tr>
<td>
<a href="https://bazelbuild.github.io/rules_jsonnet/jsonnet/jsonnet.html#jsonnet_library">
<code>jsonnet_library</code>
</a>
</td>
<td>
<p>Creates a logical set of Jsonnet files.</p>

</td>
</tr>
<tr>
<td>
<a href="https://bazelbuild.github.io/rules_jsonnet/jsonnet/jsonnet.html#jsonnet_to_json">
<code>jsonnet_to_json</code>
</a>
</td>
<td>
<p>Compiles Jsonnet code to JSON.</p>

</td>
</tr>
<tr>
<td>
<a href="https://bazelbuild.github.io/rules_jsonnet/jsonnet/jsonnet.html#jsonnet_to_json_test">
<code>jsonnet_to_json_test</code>
</a>
</td>
<td>
<p>Compiles Jsonnet code to JSON and checks the output.</p>

</td>
</tr>
</tbody>
</table>
<h3>Macros</h3>
<table class="overview-table">
<colgroup>
<col class="col-name" />
<col class="col-description" />
</colgroup>
<tbody>
<tr>
<td>
<a href="https://bazelbuild.github.io/rules_jsonnet/jsonnet/jsonnet.html#jsonnet_repositories">
<code>jsonnet_repositories</code>
</a>
</td>
<td>
<p>Adds the external dependencies needed for the Jsonnet rules.</p>

</td>
</tr>
</tbody>
</table>


</div>

<footer class="mdl-mini-footer">
<div class="mdl-mini-footer__left-section">
<div class="mdl-logo">Bazel</div>
<ul class="mdl-mini-footer__link-list">
<li><a href="http://bazel.io">Home</a></li>
<li><a href="https://github.com/bazelbuild">GitHub</a></li>
</ul>
</div>
</footer>
</main>
</div>
<p>The documentation for rules_jsonnet can now be found <a href="https://github.com/bazelbuild/rules_jsonnet/blob/master/docs/jsonnet.md">on GitHub</a>.</p>
</body>
</html>
Loading

0 comments on commit 1839d26

Please sign in to comment.