Skip to content

Commit c33c650

Browse files
author
Vasileios Karakasis
committed
Reframe 2.7 public release
1 parent 6e8fcb1 commit c33c650

File tree

202 files changed

+25015
-1455
lines changed

Some content is hidden

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

202 files changed

+25015
-1455
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,30 @@ Users can create their own test hierarchies, create test factories for generatin
1414

1515
## Documentation
1616

17-
The official documentation is maintaned [here](https://eth-cscs.github.io/reframe/).
17+
The official documentation is maintained [here](https://eth-cscs.github.io/reframe/index.html).
18+
19+
### Manually generate the documentation
20+
21+
In order to generate the documentation yourself, these are the necessary steps:
22+
23+
1. Install [pandoc](https://pandoc.org).
24+
2. Install the Python requirements (you can do that from within a virtual environment):
25+
```
26+
pip install -r docs/requirements.txt
27+
```
28+
29+
Generate the documentation:
30+
```
31+
make -C docs
32+
```
33+
34+
And view it by opening `docs/html/index.html`.
35+
36+
If you want to view also the old documentation, you should first do the following:
37+
38+
```
39+
cd docs/html
40+
python -m http.server # or python -m SimpleHTTPServer for Python 2
41+
```
42+
43+
You can can now view all the documentation (new and old) by opening `localhost:8000` in your browser.

ci-scripts/ci-runner.bash

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -179,13 +179,6 @@ if [ $CI_EXITCODE -eq 0 ]; then
179179
swap_files reframe/settings.public.py reframe/settings.py
180180
fi
181181

182-
# FIXME: Temporary workaround for the PE upgrade on Daint
183-
if [[ $(hostname) == daint* ]]; then
184-
# Do not test modfied tests on Daint
185-
exit $CI_EXITCODE
186-
fi
187-
188-
189182
# Find modified or added user checks
190183
userchecks=( $(git log --name-status --oneline --no-merges -1 | \
191184
grep -e '^[AM][[:space:]]*checks/.*\.py$' | \

docs/Makefile

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
PYTHON = python
6+
SPHINXOPTS =
7+
SPHINXBUILD = -msphinx
8+
SPHINXPROJ = ReFrame
9+
SOURCEDIR = .
10+
BUILDDIR = $(VERSION)
11+
PANDOC = pandoc
12+
PANDOCOPTS = --columns 1000
13+
RM = /bin/rm -rf
14+
15+
ifeq ($(finstring "darwin", $(OSTYPE)), "darwin")
16+
SYMLINK_DIR=ln -sfh
17+
else
18+
# Assume a GNU/Linux system here
19+
SYMLINK_DIR=ln -sfn
20+
endif
21+
22+
MDS = about.md \
23+
advanced.md \
24+
configure.md \
25+
deferrables.md \
26+
pipeline.md \
27+
running.md \
28+
started.md \
29+
tutorial.md \
30+
usecases.md
31+
32+
RSTS = $(MDS:.md=.rst)
33+
34+
TARGET_DOCS := \
35+
help \
36+
html \
37+
dirhtml \
38+
singlehtml \
39+
pickle \
40+
json \
41+
htmlhelp \
42+
qthelp \
43+
devhelp \
44+
epub \
45+
latex \
46+
latexpdf \
47+
latexpdfja \
48+
text \
49+
man \
50+
textinfo \
51+
info \
52+
gettext \
53+
changes \
54+
xml \
55+
pseudoxml \
56+
linkcheck \
57+
doctest \
58+
coverage
59+
60+
all: $(RSTS)
61+
@make html
62+
@touch html/.nojekyll
63+
@echo 'Linking to old documentation pages'
64+
@cd html && $(SYMLINK_DIR) ../old _old && cd - > /dev/null
65+
66+
%.rst: %.md
67+
$(PANDOC) $(PANDOCOPTS) --from=markdown --to=rst --output=$(@) $(@:.rst=.md)
68+
69+
clean:
70+
@echo 'Removing md files'
71+
-$(RM) $(RSTS) doctrees
72+
73+
distclean: clean
74+
@echo 'Removing directories'
75+
-$(RM) $(TARGET_DOCS)
76+
77+
$(TARGET_DOCS): Makefile
78+
@$(PYTHON) $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
79+
80+
81+
.PHONY: clean Makefile
466 KB
Binary file not shown.

docs/_static/fonts/Lato-Bold.ttf

641 KB
Binary file not shown.
167 KB
Binary file not shown.
175 KB
Binary file not shown.
165 KB
Binary file not shown.
177 KB
Binary file not shown.
75.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)