Merge pull request #27 from vkarak/deploy/reframe-2.8.1

Reframe 2.8.1 public release

Author: vkarak

.gitignore

@@ -65,6 +65,9 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/html/
+docs/html/
+.doctrees/
 
 # PyBuilder
 target/

docs/Makefile

@@ -2,34 +2,17 @@
 #
 
 # You can set these variables from the command line.
-BUILD_CMD   = build
 DOCS        = docs
-DOCS_ALL    = _build/_allversions
-MASTER      = master
-PYTHON      = python
+PYTHON      = python3
 SPHINXOPTS  =
 SPHINXBUILD =  -msphinx
 SPHINXPROJ  = ReFrame
 SPHINX_VERS = sphinx-versioning
 SOURCEDIR   = .
 BUILDDIR    = $(VERSION)
-PANDOC      = pandoc
-PANDOCOPTS  = --columns 1000
 RM          = /bin/rm -rf
 TAG_VERS    = '^v\d+(\.\d+)*[a-z]*'
 
-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 \
@@ -56,24 +39,17 @@ TARGET_DOCS := \
 	doctest \
 	coverage
 
-all: $(RSTS)
+all:
 	@$(SPHINX_VERS) -l conf.py build docs/ html/
 	@rsync -az old/ html/_old/
 	@./link_old_docs.sh
 
-latest: $(RSTS)
+latest:
 	@make html
 	@touch html/.nojekyll
 	@rsync -az old/ html/_old/
 
-%.rst: %.md
-	$(PANDOC) $(PANDOCOPTS) --from=markdown --to=rst --output=$(@) $(@:.rst=.md)
-
 clean:
-	@echo 'Removing md files'
-	-$(RM) $(RSTS)
-
-distclean: clean
 	@echo 'Removing directories'
 	-$(RM) $(TARGET_DOCS) doctrees
 
@@ -82,4 +58,4 @@ $(TARGET_DOCS): Makefile
 
 
 
-.PHONY: all distclean clean latest Makefile
+.PHONY: all clean latest Makefile

docs/_templates/breadcrumbs.html

@@ -1,5 +1,5 @@
 <div role="navigation" aria-label="breadcrumbs navigation">
-  <div style="text-align: center; margin-bottom: -1.5em; display: block">ReFrame {{ version }}</div>
+  <div style="text-align: center; margin-bottom: -1.5em; display: block"></div>
   <ul class="wy-breadcrumbs">
     <li><a href="{{ pathto(master_doc) }}">Docs</a> &raquo;</li>
       {% for doc in parents %}
@@ -27,4 +27,4 @@
       {% endif %}
     </div>
   {% endif %}
-</div>
+</div>

docs/about.md renamed to docs/about.rst

@@ -1,36 +1,37 @@
-# About ReFrame
+=============
+About ReFrame
+=============
 
-## What Is ReFrame?
+What Is ReFrame?
+----------------
 
 ReFrame is a framework developed by CSCS to facilitate the writing of regression tests that check the sanity of HPC systems.
-Its main goal is to allow users to write their own regression tests without having to deal with all the details of setting up the environment for the test, quering the status of their job, managing the output of the job and looking for sanity and/or performance results.
+Its main goal is to allow users to write their own regression tests without having to deal with all the details of setting up the environment for the test, querying the status of their job, managing the output of the job and looking for sanity and/or performance results.
 Users should be concerned only about the logical requirements of their tests.
 This allows users' regression checks to be maintained and adapted to new systems easily.
 
 The user describes his test in a simple Python class and the framework takes care of all the details of the low-level interaction with the system.
 The framework is structured in such a way that with a basic knowledge of Python and minimal coding a user can write a regression test, which will be able to run out-of-the-box on a variety of systems and programming environments.
 
 Writing regression tests in a high-level language, such as Python, allows users to take advantage of the language's higher expressiveness and bigger capabilities compared to classical shell scripting, which is the norm in HPC testing.
-This could lead to a more manageable code base of regression tests with significanly reduced maintenance costs.
+This could lead to a more manageable code base of regression tests with significantly reduced maintenance costs.
 
-## ReFrame's Goals
+ReFrame's Goals
+---------------
 
 When designing the framework we have set three major goals:
 
 Productivity
-: The writer of a regression test should focus only on the logical structure and requirements of the test and should not need to deal with any of the low level details of interacting with the system, e.g., how the environment of the test is loaded, how the associated job is created and has its status checked, how the output parsing is performed etc.
-
-
+  The writer of a regression test should focus only on the logical structure and requirements of the test and should not need to deal with any of the low level details of interacting with the system, e.g., how the environment of the test is loaded, how the associated job is created and has its status checked, how the output parsing is performed etc.
 Portability
-:  Configuring the framework to support new systems and system configurations should be easy and should not affect the existing tests.
-   Also, adding support of a new system in a regression test should require minimal adjustments.
-
+  Configuring the framework to support new systems and system configurations should be easy and should not affect the existing tests.
+  Also, adding support of a new system in a regression test should require minimal adjustments.
 Robustness and ease of use
-:  The new framework must be stable enough and easy to use by non-advanced users.
-   When the system needs to be returned to users outside normal working hours the personnel in charge should be able to run the regression suite and verify the sanity of the system with a minimal involvement.
-
+  The new framework must be stable enough and easy to use by non-advanced users.
+  When the system needs to be returned to users outside normal working hours the personnel in charge should be able to run the regression suite and verify the sanity of the system with a minimal involvement.
 
-## Why ReFrame?
+Why ReFrame?
+------------
 
 HPC systems are highly complex systems in all levels of integration;
 from the physical infrastructure up to the software stack provided to the users.
@@ -44,7 +45,7 @@ Similarly, porting a test to a different system may require significant effort i
 
 ReFrame was designed to help HPC support teams to easily write tests that
 
-* monitor the impact of changes to the system that would affect negativelly the users,
+* monitor the impact of changes to the system that would affect negatively the users,
 * monitor system performance,
 * monitor system stability and
 * guarantee quality of service.