File tree 2 files changed +8
-5
lines changed 2 files changed +8
-5
lines changed Original file line number Diff line number Diff line change @@ -18,7 +18,7 @@ Core components of this package are based on the original WFDB specifications. T
18
18
Documentation and Usage
19
19
-----------------------
20
20
21
- See the documentation site for the public APIs.
21
+ See the ` documentation site `_ for the public APIs.
22
22
23
23
See the `demo.ipynb `_ notebook file for more example use cases.
24
24
@@ -49,7 +49,7 @@ Contributing
49
49
We welcome community contributions in the form of pull requests. When contributing code, please ensure:
50
50
51
51
* PEP8 _ style guidelines are followed.
52
- * Documentation is provided. New functions and classes should have numpy/scipy style docstrings _.
52
+ * Documentation is provided. New functions and classes should have numpy/scipy style docstrings _.
53
53
* Unit tests are written for new features that are not covered by `existing tests `_.
54
54
55
55
@@ -64,6 +64,8 @@ Authors
64
64
.. |Build Status | image :: https://travis-ci.org/MIT-LCP/wfdb-python.svg?branch=master
65
65
:target: https://travis-ci.org/MIT-LCP/wfdb-python
66
66
67
+ .. _documentation site : http://wfdb.readthedocs.io
68
+
67
69
.. _PEP8 : https://www.python.org/dev/peps/pep-0008/
68
70
.. _docstrings : https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
69
71
.. _existing tests : https://github.com/MIT-LCP/wfdb-python/tree/master/tests
Original file line number Diff line number Diff line change 50
50
copyright = '2018, MIT Lab for Computational Physiology'
51
51
author = 'Chen Xie, Julien Dubiel'
52
52
53
- import wfdb
53
+ with open ('../wfdb/version.py' ) as f :
54
+ __version__ = f .read ().split ()[- 1 ].strip ("'" )
54
55
# The version info for the project you're documenting, acts as replacement for
55
56
# |version| and |release|, also used in various other places throughout the
56
57
# built documents.
57
58
#
58
59
# The short X.Y version.
59
- version = wfdb . __version__
60
+ version = __version__
60
61
# The full version, including alpha/beta/rc tags.
61
- release = wfdb . __version__
62
+ release = __version__
62
63
63
64
# The language for content autogenerated by Sphinx. Refer to documentation
64
65
# for a list of supported languages.
You can’t perform that action at this time.
0 commit comments