Skip to content

Commit

Permalink
doc: generate self-documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
filmil committed Feb 5, 2025
1 parent 2a9ec2b commit 96332eb
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 3 deletions.
14 changes: 12 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,25 @@ jobs:
version: 6.0.0
- name: Checkout
uses: actions/checkout@v2
- name: "Build book"
- name: "Build ebook-example"
run: "cd ebook-example && bazel build //:html_chunked"
- name: "Build bazel-ebook manual"
run: "bazel build //:bazel_ebook_html"
- name: "Examine the environment"
run: "ls -lR && ls -lR ./ebook-example/bazel-bin && ls -lR ./ebook-example/bazel-bin/html_chunked.d"
- name: "Deploy"
- name: "Deploy ebook-example"
uses: peaceiris/actions-gh-pages@v3
with:
external_repository: filmil/hdlfactory.com.template
publish_dir: ./ebook-example/bazel-bin/html_chunked.d/html_chunked
destination_dir: static/html_chunked
publish_branch: main
deploy_key: "${{ secrets.DEPLOY_KEY }}"
- name: "Deploy bazel_ebook_html"
uses: peaceiris/actions-gh-pages@v3
with:
external_repository: filmil/hdlfactory.com.template
publish_dir: ./bazel-bin/bazel_ebook_html.d/bazel_ebook_html
destination_dir: static/html_chunked
publish_branch: main
deploy_key: "${{ secrets.DEPLOY_KEY }}"
32 changes: 31 additions & 1 deletion BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,35 @@
# This file has been licensed under Apache 2.0 license. Please see the LICENSE
# file at the root of the repository.

# Top level directory must have a BUILD.bazel file, even if empty.
load("//build:rules.bzl",
"markdown_lib",
"pandoc_chunked_html",
"ebook_pdf",
)

markdown_lib(
name = "manual_src",
srcs = [
"README.md",
],
)

pandoc_chunked_html(
name = "bazel_ebook_html",
deps = [
":manual_src",
],
toc = True,
title = "Bazel Ebook Tools",
filters = [
"@pandoc_crossref//:pandoc_crossref",
],
)

# Missing rsvg-convert (for now).
#ebook_pdf(
#name = "bazel_ebook_pdf",
#deps = [":manual_src"],
#metadata_xml = "empty.xml",
#title_yaml = "empty.yaml",
#)
Empty file added empty.xml
Empty file.
Empty file added empty.yaml
Empty file.

0 comments on commit 96332eb

Please sign in to comment.