--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.SphinxdocGenerator.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,83 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.QScintilla.DocstringGenerator.SphinxdocGenerator</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.QScintilla.DocstringGenerator.SphinxdocGenerator</h1> + +<p> +Module implementing the docstring generator for the 'sphinxdoc' style. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#generateSphinxDoc">generateSphinxDoc</a></td> +<td>Function to generate the docstring line list iaw.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="generateSphinxDoc" ID="generateSphinxDoc"></a> +<h2>generateSphinxDoc</h2> +<b>generateSphinxDoc</b>(<i>functionInfo</i>) + +<p> + Function to generate the docstring line list iaw. Sphinx documentation + style. +</p> +<p> + Note: Text is created with DESCRIPTION placeholders for descriptions and + TYPE placeholders for type information +</p> +<dl> + +<dt><i>functionInfo</i> (FunctionInfo)</dt> +<dd> +object containing the function information to base + the docstring on +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of docstring lines +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file