Skip to content

Commit

Permalink
fix docs, cleanup bad requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
edA-qa mort-ora-y committed Apr 17, 2021
1 parent b6ea93c commit f9bc8c5
Show file tree
Hide file tree
Showing 22 changed files with 2,202 additions and 187 deletions.
55 changes: 19 additions & 36 deletions dev_requirements.txt
View file
Original file line number Diff line number Diff line change
@@ -1,50 +1,33 @@
alabaster==0.7.12
attrs==19.3.0
Babel==2.8.0
bleach==3.1.5
certifi==2020.6.20
cffi==1.14.0
chardet==3.0.4
colorama==0.4.3
cryptography==3.0
attrs==20.3.0
Babel==2.9.0
certifi==2020.12.5
chardet==4.0.0
docutils==0.16
idna==2.10
imagesize==1.2.0
importlib-metadata==1.7.0
iniconfig==1.0.1
jeepney==0.4.3
Jinja2==2.11.2
keyring==21.2.1
importlib-metadata==3.10.1
iniconfig==1.1.1
Jinja2==2.11.3
MarkupSafe==1.1.1
more-itertools==8.4.0
packaging==20.4
pkg-resources==0.0.0
pkginfo==1.5.0.1
packaging==20.9
pluggy==0.13.1
py==1.9.0
pycparser==2.20
Pygments==2.6.1
py==1.10.0
Pygments==2.8.1
pyparsing==2.4.7
pytest==6.0.1
pytz==2020.1
readme-renderer==26.0
requests==2.24.0
requests-toolbelt==0.9.1
rfc3986==1.4.0
SecretStorage==3.1.2
six==1.15.0
snowballstemmer==2.0.0
Sphinx==3.1.2
pytest==6.2.3
pytz==2021.1
requests==2.25.1
snowballstemmer==2.1.0
Sphinx==3.5.4
sphinx-epytext==0.0.4
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==1.0.3
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.4
toml==0.10.1
tqdm==4.48.0
twine==3.2.0
urllib3==1.25.10
webencodings==0.5.1
zipp==3.1.0
toml==0.10.2
typing-extensions==3.7.4.3
urllib3==1.26.4
zipp==3.4.1
7 changes: 3 additions & 4 deletions doc-in/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, '/home/src/mortoray.com/master/src/shelljob/python3/shelljob')

import sys
sys.path.insert(0, 'src/')

# -- General configuration ------------------------------------------------

Expand Down Expand Up @@ -50,7 +49,7 @@

# General information about the project.
project = 'shelljob'
copyright = '2017, edA-qa mort-ora-y'
copyright = '2017-2021, edA-qa mort-ora-y'
author = 'edA-qa mort-ora-y'

# The version info for the project you're documenting, acts as replacement for
Expand Down
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 28b802dca4057b79ed54135d34f28d6b
config: 51ed28953d0eeed5e88ec5fe6635a4e1
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/shelljob.doctree
View file
Binary file not shown.
9 changes: 4 additions & 5 deletions docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; shelljob 0.5.5 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />

Expand Down Expand Up @@ -88,10 +87,10 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017, edA-qa mort-ora-y.
&copy;2017-2021, edA-qa mort-ora-y.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>
Expand Down
27 changes: 16 additions & 11 deletions docs/_modules/shelljob/proc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>shelljob.proc &#8212; shelljob 0.5.5 documentation</title>
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />

Expand Down Expand Up @@ -59,29 +58,33 @@ <h1>Source code for shelljob.proc</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">handles</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">waiting</span> <span class="o">=</span> <span class="mi">0</span>

<div class="viewcode-block" id="Group.run"><a class="viewcode-back" href="../../shelljob.html#shelljob.proc.Group.run">[docs]</a> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span> <span class="o">=</span> <span class="kc">False</span> <span class="p">):</span>
<div class="viewcode-block" id="Group.run"><a class="viewcode-back" href="../../shelljob.html#shelljob.proc.Group.run">[docs]</a> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">encoding</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">on_error</span> <span class="o">=</span> <span class="kc">None</span> <span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Adds a new process to this object. This process is run and the output collected.</span>
<span class="sd"> </span>
<span class="sd"> @param cmd: the command to execute. This may be an array as passed to Popen,</span>
<span class="sd"> or a string, which will be parsed by &#39;shlex.split&#39;</span>
<span class="sd"> @param shell: should it be run in a shell (see call)</span>
<span class="sd"> @param encoding: should lines be decoded automatically. Be aware if the decoding fails then the streaming will be interrupted.</span>
<span class="sd"> @param on_error: Called with any exception generated in the processing.</span>
<span class="sd"> @return: the handle to the process return from Popen</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_run_impl</span><span class="p">(</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span> <span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_run_impl</span><span class="p">(</span> <span class="n">cmd</span><span class="o">=</span><span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="n">shell</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="n">encoding</span><span class="p">,</span> <span class="n">on_error</span><span class="o">=</span><span class="n">on_error</span> <span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">CommandException</span><span class="p">(</span> <span class="s2">&quot;Group.run &#39;</span><span class="si">{}</span><span class="s2">&#39; failed&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> <span class="n">cmd</span> <span class="p">)</span> <span class="p">)</span> <span class="kn">from</span> <span class="nn">e</span></div>

<span class="k">def</span> <span class="nf">_run_impl</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span> <span class="p">):</span>
<span class="k">def</span> <span class="nf">_run_impl</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="p">,</span> <span class="n">encoding</span><span class="p">,</span> <span class="n">on_error</span> <span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">_expand_cmd</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span>

<span class="n">handle</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span> <span class="n">cmd</span><span class="p">,</span>
<span class="n">shell</span> <span class="o">=</span> <span class="n">shell</span><span class="p">,</span>
<span class="n">bufsize</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="n">bufsize</span> <span class="o">=</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">encoding</span> <span class="k">else</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">stdout</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
<span class="n">stderr</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">,</span>
<span class="n">stdin</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> <span class="c1"># needed to detach from calling terminal (other wacky things can happen)</span>
<span class="n">close_fds</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<span class="n">encoding</span> <span class="o">=</span> <span class="n">encoding</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">handle</span><span class="o">.</span><span class="n">group_output_done</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">handles</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="n">handle</span> <span class="p">)</span>
Expand All @@ -90,9 +93,11 @@ <h1>Source code for shelljob.proc</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">waiting</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">def</span> <span class="nf">block_read</span><span class="p">():</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="nb">iter</span><span class="p">(</span> <span class="n">handle</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">readline</span><span class="p">,</span> <span class="sa">b</span><span class="s1">&#39;&#39;</span> <span class="p">):</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="nb">iter</span><span class="p">(</span> <span class="n">handle</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">readline</span><span class="p">,</span> <span class="s1">&#39;&#39;</span> <span class="k">if</span> <span class="n">encoding</span> <span class="k">else</span> <span class="sa">b</span><span class="s1">&#39;&#39;</span> <span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">put</span><span class="p">(</span> <span class="p">(</span> <span class="n">handle</span><span class="p">,</span> <span class="n">line</span> <span class="p">)</span> <span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">on_error</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">on_error</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
<span class="k">pass</span>

<span class="c1"># To force return of any waiting read (and indicate this process is done</span>
Expand Down Expand Up @@ -356,10 +361,10 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017, edA-qa mort-ora-y.
&copy;2017-2021, edA-qa mort-ora-y.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>
Expand Down
30 changes: 18 additions & 12 deletions docs/_static/basic.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -277,25 +277,25 @@ p.rubric {
font-weight: bold;
}

img.align-left, .figure.align-left, object.align-left {
img.align-left, figure.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}

img.align-right, .figure.align-right, object.align-right {
img.align-right, figure.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}

img.align-center, .figure.align-center, object.align-center {
img.align-center, figure.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}

img.align-default, .figure.align-default {
img.align-default, figure.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
Expand All @@ -319,7 +319,8 @@ img.align-default, .figure.align-default {

/* -- sidebars -------------------------------------------------------------- */

div.sidebar {
div.sidebar,
aside.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px;
Expand Down Expand Up @@ -377,12 +378,14 @@ div.body p.centered {
/* -- content of sidebars/topics/admonitions -------------------------------- */

div.sidebar > :last-child,
aside.sidebar > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}

div.sidebar::after,
aside.sidebar::after,
div.topic::after,
div.admonition::after,
blockquote::after {
Expand Down Expand Up @@ -455,20 +458,22 @@ td > :last-child {

/* -- figures --------------------------------------------------------------- */

div.figure {
div.figure, figure {
margin: 0.5em;
padding: 0.5em;
}

div.figure p.caption {
div.figure p.caption, figcaption {
padding: 0.3em;
}

div.figure p.caption span.caption-number {
div.figure p.caption span.caption-number,
figcaption span.caption-number {
font-style: italic;
}

div.figure p.caption span.caption-text {
div.figure p.caption span.caption-text,
figcaption span.caption-text {
}

/* -- field list styles ----------------------------------------------------- */
Expand Down Expand Up @@ -693,7 +698,7 @@ pre {
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}

pre, div[class|="highlight"] {
pre, div[class*="highlight-"] {
clear: both;
}

Expand All @@ -704,7 +709,7 @@ span.pre {
hyphens: none;
}

div[class^="highlight-"] {
div[class*="highlight-"] {
margin: 1em 0;
}

Expand Down Expand Up @@ -764,6 +769,7 @@ div.code-block-caption code {
}

table.highlighttable td.linenos,
span.linenos,
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
}
Expand Down
14 changes: 10 additions & 4 deletions docs/_static/doctools.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand All @@ -29,9 +29,14 @@ if (!window.console || !console.firebug) {

/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
return decodeURIComponent(x).replace(/\+/g, ' ');
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};

/**
Expand Down Expand Up @@ -285,9 +290,10 @@ var Documentation = {
initOnKeyListeners: function() {
$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box or textarea
// don't navigate when in search box, textarea, dropdown or button
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
&& !event.shiftKey) {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');
Expand Down
6 changes: 3 additions & 3 deletions docs/_static/language_data.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];


/* Non-minified version JS is _stemmer.js if file is provided */
/* Non-minified version is copied as a separate JS file, is available */

/**
* Porter Stemmer
*/
Expand Down Expand Up @@ -199,7 +200,6 @@ var Stemmer = function() {




var splitChars = (function() {
var result = {};
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
Expand Down
Loading

0 comments on commit f9bc8c5

Please sign in to comment.