Skip to content

Commit 251879e

Browse files
committed
Add dash docset generation CI pipeline
Add CI job to create a dash docset and upload as an artifact. Also make some slight tweaks to the docset itself, by specifying the index page, and adding both 16x16, and 32x32 icons.
1 parent 00f6055 commit 251879e

File tree

5 files changed

+25
-5
lines changed

5 files changed

+25
-5
lines changed

.github/workflows/main.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,26 @@ concurrency:
1515
cancel-in-progress: true
1616

1717
jobs:
18+
make_dash_docset:
19+
runs-on: macos-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
- name: Setup Python
23+
uses: actions/setup-python@v5
24+
with:
25+
python-version: '3.x'
26+
- name: Install Build Dependencies
27+
run: |
28+
python -m pip install --upgrade doc2dash setuptools -r doc/requirements.txt
29+
- name: Build docset
30+
run: |
31+
make -C doc dash
32+
- run: tar --exclude='.DS_Store' -cvzf pyqtgraph.tgz doc/pyqtgraph.docset
33+
- name: Upload docset
34+
uses: actions/upload-artifact@v4
35+
with:
36+
name: pyqtgraph.docset
37+
path: pyqtgraph.tgz
1838
run-mypy:
1939
runs-on: ubuntu-latest
2040
steps:

doc/Makefile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,11 @@ dash: clean
5555
export BUILD_DASH_DOCSET=1;\
5656
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/dash
5757
doc2dash -n pyqtgraph\
58+
--index-page index.html\
5859
--online-redirect-url https://pyqtgraph.readthedocs.io/en/latest\
59-
--icon $(SOURCEDIR)/_static/peegee_03_square_no_bg_32_cleaned.png\
60+
--icon $(SOURCEDIR)/_static/docset-icon.png\
61+
--icon-2x $(SOURCEDIR)/_static/[email protected]\
6062
--force\
61-
-A\
6263
$(BUILDDIR)/dash
6364
@echo
6465

doc/source/_static/docset-icon.png

1.15 KB
Loading

doc/source/conf.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,8 @@
144144

145145
# favicons
146146
favicons = [
147-
"peegee_03_square_no_bg_32_cleaned.png",
148-
"peegee_04_square_no_bg_180_cleaned.png",
147+
"docset-icon.png",
148+
"docset-icon@2x.png",
149149
"peegee_03_square_no_bg_32_cleaned.ico"
150150
]
151151

@@ -187,7 +187,6 @@
187187
# The name of an image file (within the static path) to use as favicon of the
188188
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
189189
# pixels large.
190-
# html_favicon = "_static/peegee_03_square_no_bg_32_cleaned.ico"
191190

192191
# Add any paths that contain custom static files (such as style sheets) here,
193192
# relative to this directory. They are copied after the builtin static files,

0 commit comments

Comments
 (0)