Skip to content

Conversation

@vkarak
Copy link
Contributor

@vkarak vkarak commented May 17, 2020

Documentation is enhanced and expanded:

  • Pages are grouped into larger groups with separate TOCs.
  • The whole documentation was updated removing inaccurate or obsolete information.
  • A man page serving as a command-line reference was added.
  • A configuration reference was added as well.
  • Minor code bug fixes that were discovered during rereading of the docs.
  • Sphinx minimum version bumped to 3.0

Fixes #1312
Fixes #1299
Fixes #1288
Fixes #1157
Fixes #67

Documentation is enhanced and expanded:

- Pages are grouped into larger groups with separate TOCs.
- The whole documentation was updated removing inaccurate or obsolete
  information.
- A man page serving as a command-line reference was added.
- A configuration reference was added as well.
- Minor code bug fixes that were discovered during rereading of the docs.
- Sphinx minimum version bumped to 3.0
@vkarak vkarak added this to the ReFrame sprint 20.07 milestone May 17, 2020
@vkarak vkarak requested review from ekouts, teojgo and victorusu May 17, 2020 18:31
@vkarak vkarak self-assigned this May 17, 2020
@pep8speaks
Copy link

pep8speaks commented May 17, 2020

Hello @vkarak, Thank you for updating!

Cheers! There are no PEP8 issues in this Pull Request!Do see the ReFrame Coding Style Guide

Comment last updated at 2020-05-19 13:59:01 UTC

Copy link
Contributor

@teojgo teojgo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only minor fixes are needed

Copy link
Contributor

@ekouts ekouts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@codecov-commenter
Copy link

codecov-commenter commented May 19, 2020

Codecov Report

Merging #1323 into master will increase coverage by 0.11%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1323      +/-   ##
==========================================
+ Coverage   91.62%   91.73%   +0.11%     
==========================================
  Files          83       83              
  Lines       12506    12486      -20     
==========================================
- Hits        11458    11454       -4     
+ Misses       1048     1032      -16     
Impacted Files Coverage Δ
reframe/core/containers.py 100.00% <ø> (ø)
reframe/core/decorators.py 96.90% <ø> (ø)
reframe/core/environments.py 95.65% <ø> (+9.11%) ⬆️
reframe/core/launchers/__init__.py 95.00% <ø> (ø)
reframe/core/modules.py 62.43% <ø> (ø)
reframe/core/pipeline.py 93.22% <ø> (ø)
reframe/core/runtime.py 94.15% <ø> (ø)
reframe/utility/sanity.py 98.94% <ø> (-0.01%) ⬇️
reframe/core/buildsystems.py 96.75% <100.00%> (ø)
reframe/core/schedulers/__init__.py 98.83% <100.00%> (+3.35%) ⬆️
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6cee3d4...067f364. Read the comment docs.

@vkarak vkarak merged commit 7396547 into reframe-hpc:master May 19, 2020
@vkarak vkarak deleted the docs/refine-docs branch May 19, 2020 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment