Skip to content

Commit a05eb81

Browse files
committed
Create a src directory with the User Guide content, move Python code to a module
1 parent da98bc3 commit a05eb81

File tree

310 files changed

+221
-217
lines changed

Some content is hidden

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

310 files changed

+221
-217
lines changed

.github/workflows/gh-pages.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434
restore-keys: |
3535
${{ runner.os }}-pip-
3636
- name: Install dependencies
37-
run: python3 -m pip install -U -r ./requirements.txt
37+
run: python3 -m pip install -U -e .[all]
3838

3939
- name: Build documentation
4040
run: make html

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ branches:
1515

1616
before_script:
1717
- pip install -U pip setuptools wheel typing
18-
- pip install cwltool cwltest html5lib
18+
- pip install -e .[all]
1919

2020
script:
2121
- make RUNNER=cwltool unittest-examples

AUTHORS renamed to AUTHORS.md

File renamed without changes.

CITATION renamed to CITATION.md

File renamed without changes.

Gemfile

Lines changed: 0 additions & 11 deletions
This file was deleted.

Gemfile.lock

Lines changed: 0 additions & 70 deletions
This file was deleted.

Makefile

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,38 +3,46 @@
33

44
# You can set these variables from the command line, and also
55
# from the environment for the first two.
6-
SPHINXOPTS = "-W"
7-
SPHINXBUILD = sphinx-build
8-
SOURCEDIR = .
9-
BUILDDIR = _build
6+
SPHINXOPTS = "-W"
7+
SPHINXBUILD = sphinx-build
8+
SOURCEDIR = src
9+
BUILDDIR = _build
10+
RUNNER = cwl-runner
1011

1112
# User-friendly check for sphinx-build
1213
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
13-
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
14+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://sphinx-doc.org/)
1415
endif
1516

1617
# Put it first so that "make" without argument is like "make help".
1718
help:
1819
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1920

20-
.PHONY: help Makefile
21+
clean:
22+
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
23+
# Add any other directories to be removed below this line.
2124

22-
watch:
25+
watch: clean
2326
@echo
2427
@echo "Building and watching for changes in the documentation."
25-
sphinx-autobuild --ignore venv . _build/html
28+
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" \
29+
--ignore='**venv' \
30+
--ignore='**.github' \
31+
--ignore='*.egg-info' \
32+
--watch='cwl'
2633

27-
## unittest : run unit tests on checking tools.
28-
unittest :
29-
@bin/test_lesson_check.py
34+
## unittest-examples :
35+
unittest-examples:
36+
$(info Checking if Docker is available for the CWL conformance tests)
37+
cd src/_includes/cwl; cwltest --test=conformance-test.yml --tool=${RUNNER}
3038

31-
#-------------------------------------------------------------------------------
32-
# Include extra commands if available.
33-
#-------------------------------------------------------------------------------
39+
## check-json :
40+
check-json:
41+
python -m json.tool < src/.zenodo.json >> /dev/null && exit 0 || echo "NOT valid JSON"; exit 1
3442

35-
-include commands.mk
43+
.PHONY: help clean watch unittest-examples check-json Makefile
3644

37-
# Catch-all target: route all unknown targets to Sphinx using the new
45+
# Catch-all target : route all unknown targets to Sphinx using the new
3846
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
3947
%: Makefile
4048
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

_config.yml

Lines changed: 0 additions & 110 deletions
This file was deleted.

commands.mk

Lines changed: 0 additions & 7 deletions
This file was deleted.

cwl/doc/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__version__='0.1'
File renamed without changes.

0 commit comments

Comments
 (0)