thouska / spotpy

A Statistical Parameter Optimization Tool
https://spotpy.readthedocs.io/en/latest/
MIT License
254 stars 152 forks source link

Describe rst #137

Closed philippkraft closed 6 years ago

philippkraft commented 6 years ago

Adds a reStructuredText description tool for Python 3.5 or later.

Usage:

rst = spotpy.describe.rst(sampler)
rst.append('This is a test for ``rst.append().``\n' * 10, 'Appending', 1)
rst.append_math(r'c = \sqrt{a^2 + b^2}')
rst.append(title='Image', titlelevel=2)
rst.append_image('https://img.shields.io/travis/thouska/spotpy/master.svg',
                 target='https://travis-ci.org/thouska/spotpy',
                 width='200px')

rst.show_in_browser()

Result:

grafik

coveralls commented 6 years ago

Pull Request Test Coverage Report for Build 493


Changes Missing Coverage Covered Lines Changed/Added Lines %
spotpy/describe.py 57 62 91.94%
<!-- Total: 73 78 93.59% -->
Files with Coverage Reduction New Missed Lines %
spotpy/algorithms/abc.py 1 89.72%
spotpy/algorithms/demcz.py 1 91.67%
spotpy/algorithms/fscabc.py 1 81.75%
<!-- Total: 3 -->
Totals Coverage Status
Change from base Build 490: 0.06%
Covered Lines: 4992
Relevant Lines: 5587

💛 - Coveralls