Skip to content

Commit cc35564

Browse files
kadlerkadler
committed
Merged in kadler/python-itoolkit (pull request #1)
Cleanup setup.py and add documentation * Clean up setup.py - Add --disable-libcall option to disable the building the itoollib and don't ship itoolkit.lib package - Update make-*.sh to use the new command line options * Allow modules to be imported during Sphinx doc build * Add documentation * Use Read the Docs theme * Update documentation URL * Add examples
1 parent c125897 commit cc35564

File tree

12 files changed

+420
-18
lines changed

12 files changed

+420
-18
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ build
22
dist
33
__pycache__
44
*.egg-info
5+
docs/_build

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This python .whl/.egg is now jointly maintained by IBM and the KrengelTech Litmi
66
All future work will be done in this repo.
77

88
###Documentation###
9-
* [doc](https://bitbucket.org/litmis/python-itoolkit/src/master/itoolkit/doc) directory in this repo
9+
* [doc](http://python-itoolkit.readthedocs.io/en/latest)
1010
* [YiPs documentation](http://yips.idevcloud.com/wiki/index.php/XMLSERVICE/Python)
1111

1212
###New whl/egg (laptop, etc.)###

‎docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build-3
7+
SPHINXPROJ = itoolkit
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/api.rst

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
.. _api::
2+
3+
API
4+
===
5+
6+
.. module:: itoolkit
7+
8+
9+
Toolkit Object
10+
--------------
11+
12+
.. autoclass:: iToolKit
13+
:members:
14+
:inherited-members:
15+
16+
Toolkit Operations
17+
------------------
18+
19+
.. autoclass:: iPgm
20+
:members:
21+
:inherited-members:
22+
23+
24+
.. autoclass:: iSrvPgm
25+
:members:
26+
:inherited-members:
27+
28+
.. autoclass:: iCmd
29+
:members:
30+
:inherited-members:
31+
32+
.. autoclass:: iCmd5250
33+
:members:
34+
:inherited-members:
35+
36+
.. autoclass:: iSh
37+
:members:
38+
:inherited-members:
39+
40+
.. autoclass:: iXml
41+
:members:
42+
:inherited-members:
43+
44+
.. autoclass:: iDS
45+
:members:
46+
:inherited-members:
47+
48+
.. autoclass:: iData
49+
:members:
50+
:inherited-members:
51+
52+
53+
Transports
54+
----------
55+
56+
HTTP Transport
57+
~~~~~~~~~~~~~~
58+
59+
.. module:: itoolkit.rest.irestcall
60+
61+
.. autoclass:: iRestCall
62+
:members:
63+
:inherited-members:
64+
65+
Database Transport
66+
~~~~~~~~~~~~~~~~~~
67+
68+
.. module:: itoolkit.db2.idb2call
69+
70+
.. autoclass:: iDB2Call
71+
:members:
72+
:inherited-members:
73+
74+
75+
Direct Memory Transport
76+
~~~~~~~~~~~~~~~~~~~~~~~
77+
78+
.. module:: itoolkit.lib.ilibcall
79+
80+
.. autoclass:: iLibCall
81+
:members:
82+
:inherited-members:
83+
84+
85+

‎docs/conf.py

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
#!/usr/bin/env python3
2+
# -*- coding: utf-8 -*-
3+
#
4+
# itoolkit documentation build configuration file, created by
5+
# sphinx-quickstart on Tue Jan 9 23:16:08 2018.
6+
#
7+
# This file is execfile()d with the current directory set to its
8+
# containing dir.
9+
#
10+
# Note that not all possible configuration values are present in this
11+
# autogenerated file.
12+
#
13+
# All configuration values have a default; values that are commented out
14+
# serve to show the default.
15+
16+
# If extensions (or modules to document with autodoc) are in another directory,
17+
# add these directories to sys.path here. If the directory is relative to the
18+
# documentation root, use os.path.abspath to make it absolute, like shown here.
19+
#
20+
import os
21+
import sys
22+
sys.path.insert(0, os.path.abspath('..'))
23+
24+
25+
# -- General configuration ------------------------------------------------
26+
27+
# If your documentation needs a minimal Sphinx version, state it here.
28+
#
29+
# needs_sphinx = '1.0'
30+
31+
# Add any Sphinx extension module names here, as strings. They can be
32+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33+
# ones.
34+
extensions = ['sphinx.ext.githubpages', 'sphinx.ext.autodoc']
35+
36+
# Add any paths that contain templates here, relative to this directory.
37+
templates_path = ['_templates']
38+
39+
# The suffix(es) of source filenames.
40+
# You can specify multiple suffix as a list of string:
41+
#
42+
# source_suffix = ['.rst', '.md']
43+
source_suffix = '.rst'
44+
45+
# The master toctree document.
46+
master_doc = 'index'
47+
48+
# General information about the project.
49+
project = 'itoolkit'
50+
copyright = '2018, Tony Cairns'
51+
author = 'Tony Cairns'
52+
53+
# The version info for the project you're documenting, acts as replacement for
54+
# |version| and |release|, also used in various other places throughout the
55+
# built documents.
56+
#
57+
# The short X.Y version.
58+
version = '1.2'
59+
# The full version, including alpha/beta/rc tags.
60+
release = '1.2'
61+
62+
# The language for content autogenerated by Sphinx. Refer to documentation
63+
# for a list of supported languages.
64+
#
65+
# This is also used if you do content translation via gettext catalogs.
66+
# Usually you set "language" from the command line for these cases.
67+
language = None
68+
69+
# List of patterns, relative to source directory, that match files and
70+
# directories to ignore when looking for source files.
71+
# This patterns also effect to html_static_path and html_extra_path
72+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
73+
74+
# The name of the Pygments (syntax highlighting) style to use.
75+
pygments_style = 'sphinx'
76+
77+
# If true, `todo` and `todoList` produce output, else they produce nothing.
78+
todo_include_todos = False
79+
80+
81+
# -- Options for HTML output ----------------------------------------------
82+
83+
# The theme to use for HTML and HTML Help pages. See the documentation for
84+
# a list of builtin themes.
85+
#
86+
html_theme = 'sphinx_rtd_theme'
87+
88+
# Theme options are theme-specific and customize the look and feel of a theme
89+
# further. For a list of options available for each theme, see the
90+
# documentation.
91+
#
92+
# html_theme_options = {}
93+
94+
# Add any paths that contain custom static files (such as style sheets) here,
95+
# relative to this directory. They are copied after the builtin static files,
96+
# so a file named "default.css" will overwrite the builtin "default.css".
97+
html_static_path = ['_static']
98+
99+
100+
# -- Options for HTMLHelp output ------------------------------------------
101+
102+
# Output file base name for HTML help builder.
103+
htmlhelp_basename = 'itoolkitdoc'
104+
105+
106+
# -- Options for LaTeX output ---------------------------------------------
107+
108+
latex_elements = {
109+
# The paper size ('letterpaper' or 'a4paper').
110+
#
111+
# 'papersize': 'letterpaper',
112+
113+
# The font size ('10pt', '11pt' or '12pt').
114+
#
115+
# 'pointsize': '10pt',
116+
117+
# Additional stuff for the LaTeX preamble.
118+
#
119+
# 'preamble': '',
120+
121+
# Latex figure (float) alignment
122+
#
123+
# 'figure_align': 'htbp',
124+
}
125+
126+
# Grouping the document tree into LaTeX files. List of tuples
127+
# (source start file, target name, title,
128+
# author, documentclass [howto, manual, or own class]).
129+
latex_documents = [
130+
(master_doc, 'itoolkit.tex', 'itoolkit Documentation',
131+
'Tony Cairns', 'manual'),
132+
]
133+
134+
135+
# -- Options for manual page output ---------------------------------------
136+
137+
# One entry per manual page. List of tuples
138+
# (source start file, name, description, authors, manual section).
139+
man_pages = [
140+
(master_doc, 'itoolkit', 'itoolkit Documentation',
141+
[author], 1)
142+
]
143+
144+
145+
# -- Options for Texinfo output -------------------------------------------
146+
147+
# Grouping the document tree into Texinfo files. List of tuples
148+
# (source start file, target name, title, author,
149+
# dir menu entry, description, category)
150+
texinfo_documents = [
151+
(master_doc, 'itoolkit', 'itoolkit Documentation',
152+
author, 'itoolkit', 'One line description of project.',
153+
'Miscellaneous'),
154+
]
155+
156+
157+

‎docs/examples.rst

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
.. _examples::
2+
3+
Examples
4+
========
5+
6+
Calling the DSPSYSSTS CL Command and Displaying Output
7+
------------------------------------------------------
8+
9+
.. include:: ../itoolkit/sample/icmd5250_dspsyssts.py
10+
:code:
11+
12+
Calling the RTVJOBA CL Command and Getting Output Parameters
13+
------------------------------------------------------------
14+
15+
.. include:: ../itoolkit/sample/icmd_rtvjoba.py
16+
:code:
17+
18+
Calling the PASE ps Command and Getting Output
19+
----------------------------------------------
20+
21+
.. include:: ../itoolkit/sample/ipase_ps.py
22+
:code:
23+
24+
Tracing to the Terminal
25+
-----------------------
26+
27+
.. include:: ../itoolkit/sample/ipgm_bad_trace_terminal.py
28+
:code:
29+
30+
Tracing to a File
31+
-----------------
32+
33+
.. include:: ../itoolkit/sample/ipgm_bad_trace_file.py
34+
:code:
35+
36+
Calling an RPG Program
37+
----------------------
38+
39+
.. include:: ../itoolkit/sample/ipgm_zzcall.py
40+
:code:
41+
42+
.. .. include:: ../itoolkit/sample/isleep_rest_async.py
43+
.. :code:
44+
45+
.. .. include:: ../itoolkit/sample/isql_callproc.py
46+
.. :code:
47+
48+
.. .. include:: ../itoolkit/sample/isql_prepare.py
49+
.. :code:
50+
51+
.. .. include:: ../itoolkit/sample/isql_query.py
52+
.. :code:
53+
54+
.. .. include:: ../itoolkit/sample/isql_rest_async.py
55+
.. :code:
56+
57+
Calling a Service Program with "Hole" Parameter
58+
-----------------------------------------------
59+
60+
.. include:: ../itoolkit/sample/isrvpgm_qgyrhrl_hole.py
61+
:code:
62+
63+
Calling a Service Program
64+
-------------------------
65+
66+
.. include:: ../itoolkit/sample/isrvpgm_qgyrhrl.py
67+
:code:
68+
69+
Calling a Service Program With an Array Parameter
70+
-------------------------------------------------
71+
72+
.. include:: ../itoolkit/sample/isrvpgm_zzarray.py
73+
:code:
74+
75+
Using \*debug to Cause XMLSERVICE to Enter a Message Wait
76+
---------------------------------------------------------
77+
78+
.. include:: ../itoolkit/sample/istop_msg_qsysopr_before_pgm_call.py
79+
:code:
80+
81+
Using iXml to Get XMLSERVICE Diagnostics
82+
----------------------------------------
83+
84+
.. include:: ../itoolkit/sample/ixml_diag.py
85+
:code:
86+
87+
Using iXml to Call a Program with a Varchar Parameter
88+
-----------------------------------------------------
89+
90+
.. include:: ../itoolkit/sample/ixml_zzvary.py
91+
:code:
92+

‎docs/index.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Welcome to itoolkit's documentation!
2+
====================================
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
:caption: Contents:
7+
8+
api
9+
examples
10+
11+
Indices and tables
12+
==================
13+
14+
* :ref:`genindex`
15+
* :ref:`modindex`
16+
* :ref:`search`

0 commit comments

Comments
 (0)