Skip to content
Open
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
46 changes: 26 additions & 20 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
fail-fast: false
matrix:
# Checks based on python versions ---
python-version: ["3.9", "3.10"]
python-version: ["3.10", "3.11", "3.12"]
requirements: [""]

include:
Expand All @@ -26,24 +26,26 @@ jobs:

steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- name: Install uv
uses: astral-sh/setup-uv@v4
with:
python-version: "${{ matrix.python-version }}"
- name: Install dev dependencies
enable-cache: true
- name: Set up Python ${{ matrix.python-version }}
run: uv python install ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip

# include requirements if specified
if [ -n "$REQUIREMENTS" ]; then
python -m pip install $REQUIREMENTS '.[dev]'
uv sync --group dev
uv pip install $REQUIREMENTS
else
python -m pip install '.[dev]'
uv sync --group dev
fi
env:
REQUIREMENTS: ${{ matrix.requirements }}
- name: Run tests
run: |
pytest --cov
uv run pytest --cov
- name: Upload results to Codecov
uses: codecov/codecov-action@v4
with:
Expand All @@ -54,13 +56,14 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- name: Install uv
uses: astral-sh/setup-uv@v4
with:
python-version: "3.10"
- name: Install dev dependencies
run: |
python -m pip install --upgrade pip
python -m pip install ".[dev]"
enable-cache: true
- name: Set up Python 3.10
run: uv python install 3.10
- name: Install dependencies
run: uv sync --group dev
- uses: pre-commit/action@v3.0.0

release-pypi:
Expand All @@ -87,16 +90,19 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- name: Install uv
uses: astral-sh/setup-uv@v4
with:
python-version: "3.10"
enable-cache: true
- name: Set up Python 3.10
run: uv python install 3.10
- name: Install dependencies
run: |
python -m pip install ".[dev]"
uv sync --group dev
# TODO: temporary installs for examples
# once quartodoc is stable we should move into their own libraries
python -m pip install shiny shinylive
python -m pip install --no-deps dascore==0.0.8
uv pip install shiny shinylive
uv pip install --no-deps dascore==0.0.8
- uses: quarto-dev/quarto-actions/setup@v2
- name: Test building starter template
run: |
Expand Down
28 changes: 7 additions & 21 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,15 @@ README.md: README.qmd
# which contains a full example for the interlinks filter to be tested

$(EXAMPLE_INTERLINKS): scripts/filter-spec/generate_files.py
python3 $<
uv run python $<

$(EXAMPLE_INTERLINKS)/test.qmd: scripts/filter-spec/generate_test_qmd.py
python3 $<
uv run python $<

$(EXAMPLE_INTERLINKS)/test.md: $(EXAMPLE_INTERLINKS)/test.qmd _extensions/interlinks/interlinks.lua
cd $(EXAMPLE_INTERLINKS) && quarto render test.qmd --to gfm


examples/%/_site: examples/%/_quarto.yml
cd examples/$* \
&& quarto add --no-prompt ../.. \
&& quarto add --no-prompt quarto-ext/shinylive
cd examples/$* && quartodoc build --config _quarto.yml --verbose
cd examples/$* && quartodoc interlinks
quarto render $(dir $<)


docs/examples/%: examples/%/_site
rm -rf docs/examples/$*
cp -rv $< $@

docs-build-examples: docs/examples/single-page docs/examples/pkgdown docs/examples/auto-package

docs-build-readme: export BUILDING_README = 1
docs-build-readme:
Expand All @@ -44,13 +30,13 @@ docs-build-readme:
--output-dir ..

docs-build: export PLUM_SIMPLE_DOC=1
docs-build: docs-build-examples
cd docs && quartodoc build --verbose
cd docs && quartodoc interlinks
docs-build:
cd docs && uv run quartodoc build --verbose
cd docs && uv run quartodoc interlinks
cd docs && quarto add --no-prompt ..
quarto render docs
uv run quarto render docs

test-overview-template:
python scripts/build_tmp_starter.py
uv run python scripts/build_tmp_starter.py

test-interlinks: quartodoc/tests/example_interlinks/test.md
5 changes: 0 additions & 5 deletions examples/pkgdown/reference/Builder.build.qmd

This file was deleted.

19 changes: 0 additions & 19 deletions examples/pkgdown/reference/Builder.qmd

This file was deleted.

26 changes: 0 additions & 26 deletions examples/pkgdown/reference/get_object.qmd

This file was deleted.

12 changes: 0 additions & 12 deletions examples/pkgdown/reference/index.qmd

This file was deleted.

22 changes: 0 additions & 22 deletions examples/pkgdown/reference/preview.qmd

This file was deleted.

17 changes: 8 additions & 9 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ classifiers = [
"Operating System :: Unix",
"Operating System :: MacOS",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11"
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12"
]
dynamic = ["version"]
requires-python = ">=3.9"
requires-python = ">=3.10"
dependencies = [
"black",
"click",
Expand All @@ -43,8 +43,7 @@ dependencies = [
"requests",
"typing-extensions >= 4.4.0",
"watchdog >= 3.0.0",
"plum-dispatch < 2.0.0; python_version < '3.10'",
"plum-dispatch > 2.0.0; python_version >= '3.10'"
"plum-dispatch > 2.0.0"
]

[project.urls]
Expand All @@ -53,7 +52,10 @@ repository = "https://github.com/machow/quartodoc"
ci = "https://github.com/machow/quartodoc/actions"


[project.optional-dependencies]
[project.scripts]
quartodoc = "quartodoc.__main__:cli"

[dependency-groups]
dev = [
"pytest<8.0.0",
"pytest-cov",
Expand All @@ -62,6 +64,3 @@ dev = [
"syrupy",
"pre-commit"
]

[project.scripts]
quartodoc = "quartodoc.__main__:cli"
Loading
Loading