Skip to content

Commit fc7c1ee

Browse files
michaelayeclaude
andcommitted
Generate API reference in CI instead of committing static files
- Add Python setup and package installation to docs workflow - Add src/** to trigger paths so API changes rebuild docs - Remove generated quartodoc reference files from tracking - Gitignore generated reference .qmd, _sidebar.yml, and CSS Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ee6c7f7 commit fc7c1ee

28 files changed

Lines changed: 14 additions & 1943 deletions

.github/workflows/docs.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ on:
55
branches: [main]
66
paths:
77
- 'docs/**'
8+
- 'src/**'
89
- '.github/workflows/docs.yml'
910
workflow_dispatch:
1011

@@ -26,6 +27,14 @@ jobs:
2627
- name: Checkout
2728
uses: actions/checkout@v4
2829

30+
- name: Set up Python
31+
uses: actions/setup-python@v5
32+
with:
33+
python-version: '3.12'
34+
35+
- name: Install package and dependencies
36+
run: pip install -e ".[dev]"
37+
2938
- name: Setup Quarto
3039
uses: quarto-dev/quarto-actions/setup@v2
3140

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,11 @@ docs/objects.json
149149
docs/README_files/
150150
docs/presentations/
151151

152+
# Generated quartodoc API reference
153+
docs/reference/*.qmd
154+
docs/reference/_sidebar.yml
155+
docs/reference/_styles-quartodoc.css
156+
152157
# Scratch/temp artifacts
153158
current_diffs*
154159
current_diffs_files/

docs/reference/_sidebar.yml

Lines changed: 0 additions & 36 deletions
This file was deleted.

docs/reference/_styles-quartodoc.css

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/reference/cli.qmd

Lines changed: 0 additions & 27 deletions
This file was deleted.

docs/reference/config.qmd

Lines changed: 0 additions & 73 deletions
This file was deleted.

docs/reference/datetime_format_converters.qmd

Lines changed: 0 additions & 98 deletions
This file was deleted.

docs/reference/dt_fmt_converters.qmd

Lines changed: 0 additions & 90 deletions
This file was deleted.

0 commit comments

Comments
 (0)