Skip to content

Commit f5fd659

Browse files
authored
➕ Add quarto as default dependency (#46)
* ➕ Add quarto as default dependency * 🐛 change not picked up on ubuntu? * 🐛 remove missing extra for building docs * 🎨 clean-up
1 parent 48de138 commit f5fd659

File tree

4 files changed

+9
-15
lines changed

4 files changed

+9
-15
lines changed

.github/workflows/cdci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ jobs:
5353
- name: Install dependencies
5454
run: |
5555
pip install --upgrade pip
56-
pip install -e ".[quarto]"
56+
pip install -e "."
5757
- name: Execute streamlit report (to check)
5858
run: |
5959
cd docs

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
- name: Install dependencies
2727
run: |
2828
python -m pip install --upgrade pip
29-
pip install -e .[docs,quarto]
29+
pip install -e .[docs]
3030
- name: Build references
3131
run: |
3232
cd docs

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,27 +47,23 @@ pip install -e path/to/vuegen # specify location
4747
pip install -e . # in case your pwd is in the vuegen directory
4848
```
4949

50-
### Quarto installation
50+
This will both install `quarto` and `streamlit` as our backends for report generation.
5151

52-
Install quarto with vueguen if you don't have it globally installed.
52+
### Verify quarto installation
53+
54+
Test your quarto installation by running the following command:
5355

5456
```bash
55-
pip install -e ".[quarto]" # specify location
57+
quarto check
5658
```
5759

58-
if you use conda a conda environement you can install quatro from the conda-forge channel
60+
If you use conda a conda environement you can install quatro from the conda-forge channel
5961
in case it did not work.
6062

6163
```bash
6264
conda install -c conda-forge quarto
6365
```
6466

65-
Test your quarto installation by running the following command:
66-
67-
```bash
68-
quarto check
69-
```
70-
7167
## Execution
7268

7369
Run VueGen using a directory with the following command:

pyproject.toml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ ipywidgets = {version="*", optional=true}
3434
sphinx-new-tab-link = {version = "!=0.2.2", optional=true}
3535
jupytext = {version="*", optional=true}
3636
# quarto
37-
quarto-cli = {version="*", optional=true}
37+
quarto-cli = "*"
3838

3939
[tool.poetry.group.dev.dependencies]
4040
ipykernel = {version="^6.29.5", optional=true}
@@ -45,8 +45,6 @@ build-backend = "poetry.core.masonry.api"
4545

4646
# https://stackoverflow.com/a/60990574/9684872
4747
[tool.poetry.extras]
48-
streamlit = ["streamlit"]
49-
quarto = ["quarto-cli", "ipykernel"]
5048
docs = ["sphinx", "sphinx-book-theme", "myst-nb", "ipywidgets", "sphinx-new-tab-link", "jupytext"]
5149

5250
[tool.poetry.scripts]

0 commit comments

Comments
 (0)