Skip to content

Commit 67d6b74

Browse files
committed
✨ add quatro-cli python package and try testing build of docs
1 parent 296adcd commit 67d6b74

File tree

2 files changed

+45
-1
lines changed

2 files changed

+45
-1
lines changed

.github/workflows/docs.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Test documentation building (until it's moved to ReadTheDocs)
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
release:
9+
types: [published]
10+
11+
jobs:
12+
test:
13+
name: Test
14+
runs-on: ubuntu-latest
15+
strategy:
16+
matrix:
17+
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
18+
steps:
19+
- uses: actions/checkout@v4
20+
- name: Set up Python ${{ matrix.python-version }}
21+
uses: actions/setup-python@v5
22+
with:
23+
python-version: ${{ matrix.python-version }}
24+
cache: 'pip' # caching pip dependencies
25+
cache-dependency-path: '**/pyproject.toml'
26+
- name: Install dependencies
27+
run: |
28+
python -m pip install --upgrade pip
29+
pip install -e .[docs,quarto]
30+
- name: Build references
31+
run: |
32+
cd docs
33+
sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../vuegen
34+
- name: Build documentation
35+
run: |
36+
cd docs
37+
sphinx-build -n -W --keep-going -b html ./ ./_build/
38+
- name: save artifacts
39+
uses: actions/upload-artifact@v3
40+
with:
41+
name: Sphinx_${{ matrix.python-version }}
42+
path: docs/_build/

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ myst-nb = {version="*", optional=true}
3535
ipywidgets = {version="*", optional=true}
3636
sphinx-new-tab-link = {version = "!=0.2.2", optional=true}
3737
jupytext = {version="*", optional=true}
38+
# quartro
39+
quatro-cli = {version="*", optional=true}
3840

3941
[tool.poetry.group.dev.dependencies]
4042
ipykernel = "^6.29.5"
@@ -47,7 +49,7 @@ build-backend = "poetry.core.masonry.api"
4749
# https://stackoverflow.com/a/60990574/9684872
4850
[tool.poetry.extras]
4951
streamlit = ["streamlit"]
50-
quarto = ["quarto", "ipykernel"]
52+
quarto = ["quarto-cli", "ipykernel"]
5153
docs = ["sphinx", "sphinx-book-theme", "myst-nb", "ipywidgets", "sphinx-new-tab-link", "jupytext"]
5254

5355
# [project.scripts]

0 commit comments

Comments
 (0)