reframe-hpc · vkarak · Nov 8, 2017 · Nov 8, 2017
diff --git a/README.md b/README.md
@@ -14,4 +14,30 @@ Users can create their own test hierarchies, create test factories for generatin
 
 ## Documentation
 
-The official documentation is maintaned [here](https://eth-cscs.github.io/reframe/).
+The official documentation is maintained [here](https://eth-cscs.github.io/reframe/index.html).
+
+### Manually generate the documentation
+
+In order to generate the documentation yourself, these are the necessary steps:
+
+1. Install [pandoc](https://pandoc.org).
+2. Install the Python requirements (you can do that from within a virtual environment):
+   ```
+   pip install -r docs/requirements.txt
+   ```
+
+Generate the documentation:
+```
+make -C docs
+```
+
+And view it by opening `docs/html/index.html`.
+
+If you want to view also the old documentation, you should first do the following:
+
+```
+cd docs/html
+python -m http.server # or python -m SimpleHTTPServer for Python 2
+```
+
+You can can now view all the documentation (new and old) by opening `localhost:8000` in your browser.
diff --git a/ci-scripts/ci-runner.bash b/ci-scripts/ci-runner.bash
@@ -179,13 +179,6 @@ if [ $CI_EXITCODE -eq 0 ]; then
     swap_files reframe/settings.public.py reframe/settings.py
 fi
 
-# FIXME: Temporary workaround for the PE upgrade on Daint
-if [[ $(hostname) == daint* ]]; then
-    # Do not test modfied tests on Daint
-    exit $CI_EXITCODE
-fi
-
-
 # Find modified or added user checks
 userchecks=( $(git log --name-status --oneline --no-merges -1 | \
                grep -e '^[AM][[:space:]]*checks/.*\.py$' | \

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,81 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+PYTHON      = python
+SPHINXOPTS  =
+SPHINXBUILD =  -msphinx
+SPHINXPROJ  = ReFrame
+SOURCEDIR   = .
+BUILDDIR    = $(VERSION)
+PANDOC      = pandoc
+PANDOCOPTS  = --columns 1000
+RM          = /bin/rm -rf
+
+ifeq ($(finstring "darwin", $(OSTYPE)), "darwin")
+SYMLINK_DIR=ln -sfh
+else
+# Assume a GNU/Linux system here
+SYMLINK_DIR=ln -sfn
+endif
+
+MDS = about.md \
+	advanced.md \
+	configure.md \
+	deferrables.md \
+	pipeline.md \
+	running.md \
+	started.md \
+	tutorial.md \
+	usecases.md
+
+RSTS = $(MDS:.md=.rst)
+
+TARGET_DOCS := \
+	help \
+	html \
+	dirhtml \
+	singlehtml \
+	pickle \
+	json \
+	htmlhelp \
+	qthelp \
+	devhelp \
+	epub \
+	latex \
+	latexpdf \
+	latexpdfja \
+	text \
+	man \
+	textinfo \
+	info \
+	gettext \
+	changes \
+	xml \
+	pseudoxml \
+	linkcheck \
+	doctest \
+	coverage
+
+all: $(RSTS)
+	@make html
+	@touch html/.nojekyll
+	@echo 'Linking to old documentation pages'
+	@cd html && $(SYMLINK_DIR) ../old _old && cd - > /dev/null
+
+%.rst: %.md
+	$(PANDOC) $(PANDOCOPTS) --from=markdown --to=rst --output=$(@) $(@:.rst=.md)
+
+clean:
+	@echo 'Removing md files'
+	-$(RM) $(RSTS) doctrees
+
+distclean: clean
+	@echo 'Removing directories'
+	-$(RM) $(TARGET_DOCS)
+
+$(TARGET_DOCS): Makefile
+	@$(PYTHON) $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+
+.PHONY: clean Makefile
diff --git a/docs/_static/files/reframe-cug17-slides.pdf b/docs/_static/files/reframe-cug17-slides.pdf
diff --git a/docs/_static/fonts/Lato-Bold.ttf b/docs/_static/fonts/Lato-Bold.ttf
diff --git a/docs/_static/fonts/RobotoSlab-Bold.ttf b/docs/_static/fonts/RobotoSlab-Bold.ttf
diff --git a/docs/_static/fonts/RobotoSlab-Light.ttf b/docs/_static/fonts/RobotoSlab-Light.ttf
diff --git a/docs/_static/fonts/RobotoSlab-Regular.ttf b/docs/_static/fonts/RobotoSlab-Regular.ttf
diff --git a/docs/_static/fonts/RobotoSlab-Thin.ttf b/docs/_static/fonts/RobotoSlab-Thin.ttf
diff --git a/docs/_static/fonts/fontawesome-webfont.woff2 b/docs/_static/fonts/fontawesome-webfont.woff2
diff --git a/docs/_static/img/deferrable-evaluation.svg b/docs/_static/img/deferrable-evaluation.svg
diff --git a/docs/_static/img/favicon.png b/docs/_static/img/favicon.png
diff --git a/docs/_static/img/logo_cscs.png b/docs/_static/img/logo_cscs.png
diff --git a/docs/_static/img/logo_ethz.png b/docs/_static/img/logo_ethz.png
diff --git a/docs/_static/img/output-scanning.pdf b/docs/_static/img/output-scanning.pdf
diff --git a/docs/_static/img/output-scanning.png b/docs/_static/img/output-scanning.png
diff --git a/docs/_static/img/pipeline.svg b/docs/_static/img/pipeline.svg
diff --git a/docs/_templates/breadcrumbs.html b/docs/_templates/breadcrumbs.html
@@ -0,0 +1,30 @@
+<div role="navigation" aria-label="breadcrumbs navigation">
+  <div style="text-align: center; margin-bottom: -1.5em; display: block">ReFrame {{ version }}</div>
+  <ul class="wy-breadcrumbs">
+    <li><a href="{{ pathto(master_doc) }}">Docs</a> &raquo;</li>
+      {% for doc in parents %}
+          <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
+      {% endfor %}
+    <li>{{ title }}</li>
+      <li class="wy-breadcrumbs-aside">
+        {% if pagename != "search" %}
+          {% if display_github %}
+            <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}" class="fa fa-github"> View on GitHub</a>
+          {% endif %}
+            <!-- <a href="https://eth-cscs.github.io/reframe">ReFrame</a> -->
+            <!-- <a href="Section_commands.html#comm">Commands</a> -->
+        {% endif %}
+      </li>
+  </ul>
+  <hr/>
+  {% if next or prev %}
+    <div class="rst-footer-buttons" style="margin-bottom: 1em" role="navigation" aria-label="footer navigation">
+      {% if next %}
+        <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+      {% endif %}
+      {% if prev %}
+        <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      {% endif %}
+    </div>
+  {% endif %}
+</div>