Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/cdci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:
- name: Install dependencies
run: |
pip install --upgrade pip
pip install -e ".[quarto]"
pip install -e "."
- name: Execute streamlit report (to check)
run: |
cd docs
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[docs,quarto]
pip install -e .[docs]
- name: Build references
run: |
cd docs
Expand Down
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,27 +47,23 @@ pip install -e path/to/vuegen # specify location
pip install -e . # in case your pwd is in the vuegen directory
```

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

Install quarto with vueguen if you don't have it globally installed.
### Verify quarto installation

Test your quarto installation by running the following command:

```bash
pip install -e ".[quarto]" # specify location
quarto check
```

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

```bash
conda install -c conda-forge quarto
```

Test your quarto installation by running the following command:

```bash
quarto check
```

## Execution

Run VueGen using a directory with the following command:
Expand Down
4 changes: 1 addition & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ ipywidgets = {version="*", optional=true}
sphinx-new-tab-link = {version = "!=0.2.2", optional=true}
jupytext = {version="*", optional=true}
# quarto
quarto-cli = {version="*", optional=true}
quarto-cli = "*"

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

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

[tool.poetry.scripts]
Expand Down