Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Gao committed Jan 8, 2018
1 parent 4101809 commit 0c4cf63
Show file tree
Hide file tree
Showing 12 changed files with 351 additions and 12 deletions.
186 changes: 186 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Python",
"type": "python",
"request": "launch",
"stopOnEntry": true,
"pythonPath": "${config:python.pythonPath}",
"program": "${file}",
"cwd": "${workspaceFolder}",
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": [
"RedirectOutput"
]
},
{
"name": "Python: Attach",
"type": "python",
"request": "attach",
"localRoot": "${workspaceFolder}",
"remoteRoot": "${workspaceFolder}",
"port": 3000,
"secret": "my_secret",
"host": "localhost"
},
{
"name": "Python: Terminal (integrated)",
"type": "python",
"request": "launch",
"stopOnEntry": true,
"pythonPath": "${config:python.pythonPath}",
"program": "${file}",
"cwd": "",
"console": "integratedTerminal",
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": []
},
{
"name": "Python: Terminal (external)",
"type": "python",
"request": "launch",
"stopOnEntry": true,
"pythonPath": "${config:python.pythonPath}",
"program": "${file}",
"cwd": "",
"console": "externalTerminal",
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": []
},
{
"name": "Python: Django",
"type": "python",
"request": "launch",
"stopOnEntry": true,
"pythonPath": "${config:python.pythonPath}",
"program": "${workspaceFolder}/manage.py",
"cwd": "${workspaceFolder}",
"args": [
"runserver",
"--noreload",
"--nothreading"
],
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": [
"RedirectOutput",
"DjangoDebugging"
]
},
{
"name": "Python: Flask (0.11.x or later)",
"type": "python",
"request": "launch",
"stopOnEntry": false,
"pythonPath": "${config:python.pythonPath}",
"program": "fully qualified path fo 'flask' executable. Generally located along with python interpreter",
"cwd": "${workspaceFolder}",
"env": {
"FLASK_APP": "${workspaceFolder}/quickstart/app.py"
},
"args": [
"run",
"--no-debugger",
"--no-reload"
],
"envFile": "${workspaceFolder}/.env",
"debugOptions": [
"RedirectOutput"
]
},
{
"name": "Python: Flask (0.10.x or earlier)",
"type": "python",
"request": "launch",
"stopOnEntry": false,
"pythonPath": "${config:python.pythonPath}",
"program": "${workspaceFolder}/run.py",
"cwd": "${workspaceFolder}",
"args": [],
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": [
"RedirectOutput"
]
},
{
"name": "Python: PySpark",
"type": "python",
"request": "launch",
"stopOnEntry": true,
"osx": {
"pythonPath": "${env:SPARK_HOME}/bin/spark-submit"
},
"windows": {
"pythonPath": "${env:SPARK_HOME}/bin/spark-submit.cmd"
},
"linux": {
"pythonPath": "${env:SPARK_HOME}/bin/spark-submit"
},
"program": "${file}",
"cwd": "${workspaceFolder}",
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": [
"RedirectOutput"
]
},
{
"name": "Python: Module",
"type": "python",
"request": "launch",
"stopOnEntry": true,
"pythonPath": "${config:python.pythonPath}",
"module": "module.name",
"cwd": "${workspaceFolder}",
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": [
"RedirectOutput"
]
},
{
"name": "Python: Pyramid",
"type": "python",
"request": "launch",
"stopOnEntry": true,
"pythonPath": "${config:python.pythonPath}",
"cwd": "${workspaceFolder}",
"env": {},
"envFile": "${workspaceFolder}/.env",
"args": [
"${workspaceFolder}/development.ini"
],
"debugOptions": [
"RedirectOutput",
"Pyramid"
]
},
{
"name": "Python: Watson",
"type": "python",
"request": "launch",
"stopOnEntry": true,
"pythonPath": "${config:python.pythonPath}",
"program": "${workspaceFolder}/console.py",
"cwd": "${workspaceFolder}",
"args": [
"dev",
"runserver",
"--noreload=True"
],
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": [
"RedirectOutput"
]
}
]
}
Binary file modified __pycache__/gsyIO.cpython-36.pyc
Binary file not shown.
Binary file modified __pycache__/gsySvg2EmfMain.cpython-36.pyc
Binary file not shown.
Binary file modified _build/doctrees/environment.pickle
Binary file not shown.
Binary file modified _build/doctrees/gsyIO.doctree
Binary file not shown.
6 changes: 4 additions & 2 deletions _build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -263,11 +263,13 @@ <h2 id="S">S</h2>
</li>
<li><a href="gsySvg2EmfMain.html#gsySvg2EmfMain.Ui_SVG2EMF.save_setting">save_setting() (gsySvg2EmfMain.Ui_SVG2EMF method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="gsyIO.html#gsyIO.save_txt">save_txt() (in module gsyIO)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="gsyIO.html#gsyIO.save_txt_on_event">save_txt_on_event() (in module gsyIO)</a>
</li>
<li><a href="gsyIO.html#gsyIO.search_file">search_file() (in module gsyIO)</a>
</li>
<li><a href="gsyIO.html#gsyIO.search_file_and_start">search_file_and_start() (in module gsyIO)</a>
</li>
Expand Down
77 changes: 77 additions & 0 deletions _build/html/gsyIO.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ <h2>2.1. Change Log<a class="headerlink" href="#change-log" title="Permalink to
<dd><ul class="first last">
<li>Added “get_dir”</li>
<li>Added “open_folder”</li>
<li>Added “search_file”</li>
</ul>
</dd>
</dl>
Expand Down Expand Up @@ -213,6 +214,7 @@ <h2>2.2. List of functions<a class="headerlink" href="#list-of-functions" title=
<li><a class="reference internal" href="#save-image-gui">save_image_gui</a></li>
<li><a class="reference internal" href="#save-txt">save_txt</a></li>
<li><a class="reference internal" href="#save-txt-on-event">save_txt_on_event</a></li>
<li><a class="reference internal" href="#search-file">search_file</a></li>
<li><a class="reference internal" href="#search-file-and-start">search_file_and_start</a></li>
</ul>
</div>
Expand Down Expand Up @@ -616,6 +618,81 @@ <h2>2.3. Function definitions<a class="headerlink" href="#function-definitions"
</div>
</dd></dl>

<dl class="function">
<dt id="gsyIO.search_file">
<code class="descclassname">gsyIO.</code><code class="descname">search_file</code><span class="sig-paren">(</span><em>str_dir_path</em>, <em>str_pattern</em>, <em>bool_recursive=True</em><span class="sig-paren">)</span><a class="headerlink" href="#gsyIO.search_file" title="Permalink to this definition"></a></dt>
<dd><p id="search-file">This function opens the folder in explorer.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>str_folder_path</strong> : str</p>
<blockquote>
<div><p>The folder path.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">None</p>
<table border="1" class="last docutils" id="id1">
<caption><span class="caption-text">Frozen Delights!</span><a class="headerlink" href="#id1" title="Permalink to this table"></a></caption>
<colgroup>
<col width="33%" />
<col width="33%" />
<col width="33%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><table class="first last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">header:</th><td class="field-body">“Treat”</td>
</tr>
</tbody>
</table>
</td>
<td>Quantity</td>
<td>Description</td>
</tr>
<tr class="row-even"><td><table class="first last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">widths:</th><td class="field-body">15</td>
</tr>
</tbody>
</table>
</td>
<td>10</td>
<td>30</td>
</tr>
<tr class="row-odd"><td>&#160;</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>Albatross</td>
<td>2.99</td>
<td>On a stick!</td>
</tr>
<tr class="row-odd"><td>Popcorn</td>
<td>1.99</td>
<td>Straight from the oven</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="code python highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">gsyIO</span>

<span class="n">str_folder</span> <span class="o">=</span> <span class="s1">&#39;c:/temp&#39;</span>

<span class="n">gsyIO</span><span class="o">.</span><span class="n">open_folder</span><span class="p">(</span><span class="n">str_folder</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>

<dl class="function">
<dt id="gsyIO.search_file_and_start">
<code class="descclassname">gsyIO.</code><code class="descname">search_file_and_start</code><span class="sig-paren">(</span><em>str_pattern</em>, <em>str_filename</em><span class="sig-paren">)</span><a class="headerlink" href="#gsyIO.search_file_and_start" title="Permalink to this definition"></a></dt>
Expand Down
Binary file modified _build/html/objects.inv
Binary file not shown.
Loading

0 comments on commit 0c4cf63

Please sign in to comment.