Skip to content

Commit 2cca9bc

Browse files
johanneskoestercoderabbitai[bot]
johanneskoester
and
coderabbitai[bot]
authored
feat: add helpers for deferred input/output etc. item access (#2927)
<!--Add a description of your PR here--> ### QC <!-- Make sure that you can tick the boxes below. --> * [x] The PR contains a test case for the changes or the changes are already covered by an existing test case. * [x] The documentation (`docs/`) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake). <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced documentation structure for various Snakemake packages, including `snakemake.assets`, `snakemake.caching`, and others. - Introduced new utility functions and classes for improved path handling and file management. - Added new test cases to validate the functionality of the `subpath` utility. - New GitHub Actions workflow for automated documentation building. - **Bug Fixes** - Improved error handling and logging capabilities in the Snakemake API. - **Documentation** - Updated URLs and references in installation documentation. - Restructured internal API documentation for better clarity. - **Chores** - Removed outdated or redundant files and dependencies from the codebase. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent c3339da commit 2cca9bc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+2010
-1200
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
concurrency:
10+
# Cancel concurrent flows on PRs
11+
group: ci-docs-${{ github.head_ref || github.run_id }}
12+
cancel-in-progress: true
13+
14+
jobs:
15+
docs:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- uses: actions/setup-python@v4
21+
with:
22+
python-version: '3.x'
23+
24+
- name: Setup doc dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install -r docs/requirements.txt
28+
29+
- name: Build docs
30+
run: |
31+
cd docs
32+
make html SPHINXOPTS="-W --keep-going -n"
33+
- name: Upload documentation
34+
uses: actions/upload-artifact@v4
35+
with:
36+
name: docs-html
37+
path: docs/_build/html/
38+
39+
apidocs:
40+
runs-on: ubuntu-latest
41+
steps:
42+
- uses: actions/checkout@v4
43+
44+
- uses: actions/setup-python@v4
45+
with:
46+
python-version: '3.x'
47+
48+
- name: Setup doc dependencies
49+
run: |
50+
python -m pip install --upgrade pip
51+
pip install -r apidocs/requirements.txt
52+
pip install -e .
53+
54+
- name: Build docs
55+
run: |
56+
cd apidocs
57+
make html SPHINXOPTS="--keep-going -n"
58+
59+
- name: Upload documentation
60+
uses: actions/upload-artifact@v4
61+
with:
62+
name: apidocs-html
63+
path: apidocs/_build/html/

‎.github/workflows/main.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,8 @@ jobs:
104104
tests/test_schema.py \
105105
tests/test_linting.py \
106106
tests/test_executor_test_suite.py \
107-
tests/test_api.py
107+
tests/test_api.py \
108+
tests/test_internals.py
108109
109110
- name: Run tests/test_report/Snakefile to generate report
110111
shell: bash -el {0}

0 commit comments

Comments
 (0)