Skip to content

Commit a130d2d

Browse files
Remove documentation build template details
Removed documentation build template section from README.
1 parent fee9fc8 commit a130d2d

1 file changed

Lines changed: 0 additions & 20 deletions

File tree

README.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,3 @@
11
# .github
22
Defaults for github shared across tskit-dev repositories
33

4-
### Documentation Build Template
5-
6-
**File:** `.github/workflows/docs-build-template.yml`
7-
8-
A reusable workflow for building documentation across all TSKit ecosystem repositories. This eliminates duplication of nearly identical documentation workflows.
9-
10-
**Usage:**
11-
```yaml
12-
jobs:
13-
docs:
14-
uses: tskit-dev/.github/.github/workflows/docs-build-template.yml@main
15-
with:
16-
requirements-path: requirements/CI-docs/requirements.txt # optional
17-
additional-setup: sudo apt-get install -y libgsl0-dev # optional
18-
make-command: make -C python # optional
19-
```
20-
**Parameters:**
21-
- `requirements-path`: Path to documentation requirements file (default: `requirements/CI-docs/requirements.txt`)
22-
- `additional-setup`: Additional setup commands (system packages, special builds, etc.)
23-
- `make-command`: Make command for building C modules before docs

0 commit comments

Comments
 (0)