Skip to content

Commit ebcaadd

Browse files
authored
GitHub Action to manually rebuild and publish documentation (#977)
* Expression profiling (legacy mode) (#936) * expression profiling * two reports * make simple report sortable * change default to grid * configurable expression_profile_cutoff * works with MP * documentation * expression_profile_style * performance_log can be bool * fix for pandas 2 * test expr profiling * test expression profiling on mtc and semcog examples * set encoding to utf8 because windows * add missing import * add warning about path length in error message * oops, .log not .csv * add timestamping to expression profile logs * fix file naming, update tests * all subprocesses to same timestamp * add note in docs about runtime cost * manual rebuild of docs * add permissions
1 parent e345f97 commit ebcaadd

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

.github/workflows/rebuild-docs.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Rebuild Docs
2+
on:
3+
workflow_dispatch:
4+
inputs:
5+
commit:
6+
description: 'Commit SHA or branch/tag to build docs from'
7+
required: true
8+
type: string
9+
version:
10+
description: 'Version number to publish docs as'
11+
required: true
12+
type: string
13+
14+
jobs:
15+
docbuild:
16+
name: ubuntu-latest py3.9
17+
runs-on: ubuntu-latest
18+
permissions:
19+
contents: write
20+
defaults:
21+
run:
22+
shell: bash -l {0}
23+
steps:
24+
- uses: actions/checkout@v4
25+
with:
26+
ref: ${{ github.event.inputs.commit }}
27+
- name: Install uv
28+
uses: astral-sh/setup-uv@v5
29+
with:
30+
version: "0.7.12"
31+
enable-cache: true
32+
cache-dependency-glob: "uv.lock"
33+
- name: "Set up Python"
34+
uses: actions/setup-python@v5
35+
with:
36+
python-version-file: ".python-version"
37+
- name: Install activitysim
38+
run: |
39+
uv sync --locked --dev
40+
- name: Build the docs
41+
run: |
42+
cd docs
43+
make clean
44+
make html
45+
- name: Push to GitHub Pages
46+
uses: peaceiris/[email protected]
47+
with:
48+
github_token: ${{ secrets.GITHUB_TOKEN }}
49+
# Token is created automatically by Github Actions, no other config needed
50+
publish_dir: ./docs/_build/html
51+
destination_dir: ${{ github.event.inputs.version }}

0 commit comments

Comments
 (0)