##// END OF EJS Templates
Fix some doc formatting in pandoc checks.
Thomas Kluyver -
Show More
@@ -47,9 +47,11 b" def pandoc(source, fmt, to, extra_args=None, encoding='utf-8'):"
47 out : unicode
47 out : unicode
48 Output as returned by pandoc.
48 Output as returned by pandoc.
49
49
50 Exceptions
50 Raises
51 ----------
51 ------
52 This function will raise PandocMissing if pandoc is not installed.
52 PandocMissing
53 If pandoc is not installed.
54
53 Any error messages generated by pandoc are printed to stderr.
55 Any error messages generated by pandoc are printed to stderr.
54
56
55 """
57 """
@@ -70,15 +72,16 b" def pandoc(source, fmt, to, extra_args=None, encoding='utf-8'):"
70 def get_pandoc_version():
72 def get_pandoc_version():
71 """Gets the Pandoc version if Pandoc is installed.
73 """Gets the Pandoc version if Pandoc is installed.
72
74
73 Return
75 Returns
74 ------
76 -------
75 If the minimal version is not met, it will probe Pandoc for its version, cache it and return that value.
77 If the minimal version is not met, it will probe Pandoc for its version, cache it and return that value.
76 If the minimal version is met, it will return the cached version and stop probing Pandoc
78 If the minimal version is met, it will return the cached version and stop probing Pandoc
77 (unless `clean_cache()` is called).
79 (unless `clean_cache()` is called).
78
80
79 Exceptions
81 Raises
80 ----------
82 ------
81 PandocMissing will be raised if pandoc is unavailable.
83 PandocMissing
84 If pandoc is unavailable.
82 """
85 """
83 global __version
86 global __version
84
87
@@ -95,9 +98,10 b' def get_pandoc_version():'
95 def check_pandoc_version():
98 def check_pandoc_version():
96 """Returns True if minimal pandoc version is met.
99 """Returns True if minimal pandoc version is met.
97
100
98 Exceptions
101 Raises
99 ----------
102 ------
100 PandocMissing will be raised if pandoc is unavailable.
103 PandocMissing
104 If pandoc is unavailable.
101 """
105 """
102 v = get_pandoc_version()
106 v = get_pandoc_version()
103 ok = check_version(v , _minimal_version )
107 ok = check_version(v , _minimal_version )
General Comments 0
You need to be logged in to leave comments. Login now