https://github.com/kspeeckaert/dashdocsets
Using Github Actions to generate my Dash docsets
https://github.com/kspeeckaert/dashdocsets
dash docset
Last synced: 13 days ago
JSON representation
Using Github Actions to generate my Dash docsets
- Host: GitHub
- URL: https://github.com/kspeeckaert/dashdocsets
- Owner: kspeeckaert
- License: mit
- Created: 2025-06-14T10:19:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-05-23T23:55:20.000Z (about 1 month ago)
- Last Synced: 2026-05-24T01:22:32.394Z (about 1 month ago)
- Topics: dash, docset
- Language: Python
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Docset Builder
*If you don't know what docsets are, have a look at [Dash](https://kapeli.com/dash) (macOS) or [Zeal](https://zealdocs.org) (Linux, macOS, Windows) and prepare to increase your productivity tenfold!*
## Instructions
For each docset you want to create, you'll need the following:
- `config` subfolder – hosts the docset related files.
- `download.sh` – Bash script to mirror the site (esentially calling `wget` ).
- `polish.py` – Python script and corresponding `requirements.txt` file to clean up the mirrored files.
- `icon.png` – the icon of your docset (don't forget to reference this in `dashing.json`).
- `dashing.json` – contains the instructions for [dashing](https://github.com/technosophos/dashing) to build your docset.
> [!IMPORTANT]
> Make sure the `package` key in `dashing.json` is set to the same value as the name of the `config` subfolder.
The resulting docset will added to the workflow's artifacts.
## Building
The repo contains 2 workflows:
- Build Docset (`build-docset.yml`) – Performs the heavy lifting and generates the docset.
- Build Orchestrator (`build-orchestrator.yml`) – The orchestrator that calls the `build-docset.yml` workflow (by passing the docset name).
The *Build Orchestrater* will gather all docsets created by the individual *Build Docset* jobs, and publish them as a new release.