This repo contains the code necessary for generating Dash docsets for bazel. The code for creating the docset started as a fork of Dashing

Install Requirements

The docset generator requires httrack to download the docs and a working golang installation to generate the docset.

brew install httrack

The scripts expect that you have a clone of the Dash-User-Contributions repo in a sibling directory of this repo's clone.

Scrape the site and generate all versions of docs

./scrape_all_docs.sh
./build_all_docs.sh

Bazel's docs are versioned in the bazel repo and consist of a mixture of automatically-generated HTML and user-written markdown files.

The site is published with google's internal devsite infrastructure, so it is not possible to build the HTML for the site entirely locally. To get around that limitation, we use the open-source httrack CLI to archive the site and all of its dependencies locally.

Once the site is archived locally, the go tool is used to crawl the html files and build up the dash docset.