diff -r 548dea93941c -r 1bd8d19a3aa7 ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateSummaryDialog.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateSummaryDialog.html Sun Nov 29 16:05:10 2020 +0100
@@ -0,0 +1,202 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateSummaryDialog</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>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateSummaryDialog</h1>
+
+<p>
+Module implementing a dialog showing a summary of all created.migrations.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#MigrateSummaryDialog">MigrateSummaryDialog</a></td>
+<td>Class implementing a dialog showing a summary of all created.migrations.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="MigrateSummaryDialog" ID="MigrateSummaryDialog"></a>
+<h2>MigrateSummaryDialog</h2>
+
+<p>
+ Class implementing a dialog showing a summary of all created.migrations.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_MigrateSummaryDialog
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#MigrateSummaryDialog.__init__">MigrateSummaryDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#MigrateSummaryDialog.__cancelProcess">__cancelProcess</a></td>
+<td>Private slot to terminate the current process.</td>
+</tr>
+<tr>
+<td><a href="#MigrateSummaryDialog.__processOutput">__processOutput</a></td>
+<td>Private method to process the flask output and populate the summary list.</td>
+</tr>
+<tr>
+<td><a href="#MigrateSummaryDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot handling a button press of the button box.</td>
+</tr>
+<tr>
+<td><a href="#MigrateSummaryDialog.on_downgradeButton_clicked">on_downgradeButton_clicked</a></td>
+<td>Private slot to downgrade to the selected revision.</td>
+</tr>
+<tr>
+<td><a href="#MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged">on_summaryWidget_itemSelectionChanged</a></td>
+<td>Private slot to handle the selection of an entry.</td>
+</tr>
+<tr>
+<td><a href="#MigrateSummaryDialog.on_upgradeButton_clicked">on_upgradeButton_clicked</a></td>
+<td>Private slot to upgrade to the selected revision.</td>
+</tr>
+<tr>
+<td><a href="#MigrateSummaryDialog.showSummary">showSummary</a></td>
+<td>Public method to show the migrations summary.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="MigrateSummaryDialog.__init__" ID="MigrateSummaryDialog.__init__"></a>
+<h4>MigrateSummaryDialog (Constructor)</h4>
+<b>MigrateSummaryDialog</b>(<i>project, migrateProject, migrations="", parent=None</i>)
+
+<p>
+ Constructor
+</p>
+<dl>
+
+<dt><i>project</i> (Project)</dt>
+<dd>
+reference to the project object
+</dd>
+<dt><i>migrateProject</i> (MigrateProject)</dt>
+<dd>
+reference to the migrate project extension
+</dd>
+<dt><i>migrations</i> (str)</dt>
+<dd>
+directory path containing the migrations
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="MigrateSummaryDialog.__cancelProcess" ID="MigrateSummaryDialog.__cancelProcess"></a>
+<h4>MigrateSummaryDialog.__cancelProcess</h4>
+<b>__cancelProcess</b>(<i></i>)
+
+<p>
+ Private slot to terminate the current process.
+</p>
+<a NAME="MigrateSummaryDialog.__processOutput" ID="MigrateSummaryDialog.__processOutput"></a>
+<h4>MigrateSummaryDialog.__processOutput</h4>
+<b>__processOutput</b>(<i>output</i>)
+
+<p>
+ Private method to process the flask output and populate the summary
+ list.
+</p>
+<dl>
+
+<dt><i>output</i> (str)</dt>
+<dd>
+output of the flask process
+</dd>
+</dl>
+<a NAME="MigrateSummaryDialog.on_buttonBox_clicked" ID="MigrateSummaryDialog.on_buttonBox_clicked"></a>
+<h4>MigrateSummaryDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+
+<p>
+ Private slot handling a button press of the button box.
+</p>
+<dl>
+
+<dt><i>button</i> (QAbstractButton)</dt>
+<dd>
+reference to the pressed button
+</dd>
+</dl>
+<a NAME="MigrateSummaryDialog.on_downgradeButton_clicked" ID="MigrateSummaryDialog.on_downgradeButton_clicked"></a>
+<h4>MigrateSummaryDialog.on_downgradeButton_clicked</h4>
+<b>on_downgradeButton_clicked</b>(<i></i>)
+
+<p>
+ Private slot to downgrade to the selected revision.
+</p>
+<a NAME="MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged" ID="MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged"></a>
+<h4>MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged</h4>
+<b>on_summaryWidget_itemSelectionChanged</b>(<i></i>)
+
+<p>
+ Private slot to handle the selection of an entry.
+</p>
+<a NAME="MigrateSummaryDialog.on_upgradeButton_clicked" ID="MigrateSummaryDialog.on_upgradeButton_clicked"></a>
+<h4>MigrateSummaryDialog.on_upgradeButton_clicked</h4>
+<b>on_upgradeButton_clicked</b>(<i></i>)
+
+<p>
+ Private slot to upgrade to the selected revision.
+</p>
+<a NAME="MigrateSummaryDialog.showSummary" ID="MigrateSummaryDialog.showSummary"></a>
+<h4>MigrateSummaryDialog.showSummary</h4>
+<b>showSummary</b>(<i></i>)
+
+<p>
+ Public method to show the migrations summary.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
