Skip to content

Commit ba5c9e5

Browse files
authored
Add troubleshooting docs (#364)
1 parent eb2c36b commit ba5c9e5

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,10 @@ source venv/bin/activate
125125
# Open <http://localhost:8000/> in your browser
126126
```
127127

128+
You can use `udocker` or any other Docker compatible engine to build the
129+
user guide, by setting the following environment variable:
130+
`CWLTOOL_OPTIONS=--udocker`, or `CWLTOOL_OPTIONS=--podman` for Podman, or `CWLTOOL_OPTIONS=--singularity` for Singularity/Apptainer.
131+
128132
> NOTE: When you modify the packages installed with apt or pip, please verify
129133
> if the change needs to be applied to either or to both of CI and readthedocs.
130134
> ReadTheDocs builds and deploys previews. CI builds and deploys production
@@ -185,6 +189,34 @@ If you are having trouble with links to sections or code blocks, it might
185189
be due to duplicated sections, or to spaces or other characters. To
186190
preview the generated links, use the `myst-anchors` tool.
187191

192+
### Troubleshooting
193+
194+
General advice for troubleshooting is to increase the verbosity of Sphinx
195+
logs. When using `make`, change your command to the following pattern:
196+
`make SPHINXOPTS="-vvv" html`. Or if you are using `sphinx-build`, then
197+
use the following: `sphinx-build -vvv -b html src build/`.
198+
199+
It is also worth removing build directories and files such as `_build`, `build`,
200+
and [`~/.cache/salad`](https://github.com/common-workflow-language/user_guide/issues/268#issuecomment-1276068865).
201+
You may want to start afresh with a new Python virtual environment,
202+
installing the dependencies from scratch.
203+
204+
If running `make html` or `make watch` appears to run fine but [gets stuck
205+
](https://github.com/common-workflow-language/user_guide/issues/268) at some
206+
part of the process (`10%`, `33%`, `57%`, etc.) for longer than 2-5 minutes
207+
you may have to try the following:
208+
209+
1. Check if the Python dependencies installed in your Python virtual environment
210+
have updates available (you can re-create the virtual environment, use `--upgrade`
211+
for `pip`, or manually verify in PyPI and `pip`).
212+
2. Use `top` or `htop` to find out if there is any `cwltool` command running. Then
213+
try running that command individually to see what is the error message.
214+
3. Upgrade your version of `docker` if you have [an error message](
215+
https://github.com/docker/compose/issues/8121#issuecomment-806055733) similar to
216+
`docker: Failed to create the container ID file: open /tmp/....cid: no such file or directory.`.
217+
4. Try using `udocker` instead of `docker`, by using `pip` to install it, and setting
218+
`CWLTOOL_OPTIONS` to `--udocker`.
219+
188220
## Other Resources
189221

190222
General discussion of [Common Workflow Language][cwl-site] project

0 commit comments

Comments
 (0)