1. litmis Avatar litmis
  2. Open Source Projects for IBM i
  3. python-itoolkit
  4. Issues

Clean up Sphinx documentation build errors

Issue #14 resolved
Kevin Adler created an issue

docstrings should be converted to restructuredtext or at least escape certain special values in rst as we currently get a bunch of warnings building documentation:

/home/kadler/projects/python-itoolkit/docs/api.rst:1: WARNING: malformed hyperlink target.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iToolKit.trace_hexdump:3: ERROR: Unexpected indentation.        
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iToolKit.trace_hexdump:4: WARNING: Block quote ends without a blank line; unexpected unindent.                                                                                                                   
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iToolKit.trace_open:1: WARNING: Inline emphasis start-string without end-string.                                                                                                                                 
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iToolKit.trace_open:4: WARNING: Inline emphasis start-string without end-string.                                                                                                                                 
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iPgm:1: WARNING: Inline emphasis start-string without end-string.                                                                                                                                                
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iPgm:7: ERROR: Unexpected indentation.                          
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iPgm:4: WARNING: Inline emphasis start-string without end-string.                                                                                                                                                
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iPgm:4: WARNING: Inline emphasis start-string without end-string.                                                                                                                                                
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iPgm:7: WARNING: Inline emphasis start-string without end-string.                                                                                                                                                
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iPgm:19: ERROR: Unexpected indentation.                         
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iPgm.add:9: ERROR: Unexpected indentation.                      
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iSrvPgm:1: WARNING: Inline emphasis start-string without end-string.                                                                                                                                             
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iSrvPgm:8: ERROR: Unexpected indentation.                       
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iSrvPgm:4: WARNING: Inline emphasis start-string without end-string.                                                                                                                                             
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iSrvPgm:4: WARNING: Inline emphasis start-string without end-string.                                                                                                                                             
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iSrvPgm:4: WARNING: Inline emphasis start-string without end-string.                                                                                                                                             
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iSrvPgm.add:9: ERROR: Unexpected indentation.                   
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iCmd:1: WARNING: Inline emphasis start-string without end-string.                                                                                                                                                
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iCmd:1: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iCmd:7: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iCmd:9: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iCmd.add:9: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iCmd5250:1: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iCmd5250:1: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iCmd5250:7: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iCmd5250.add:9: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iSh:7: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iSh.add:9: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iDS:7: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iDS.add:9: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iData:10: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iData:37: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iData:37: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/itoolkit.py:docstring of itoolkit.iData.add:9: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/rest/irestcall.py:docstring of itoolkit.rest.irestcall.iRestCall:7: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/rest/irestcall.py:docstring of itoolkit.rest.irestcall.iRestCall:9: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/kadler/projects/python-itoolkit/itoolkit/rest/irestcall.py:docstring of itoolkit.rest.irestcall.iRestCall:9: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/rest/irestcall.py:docstring of itoolkit.rest.irestcall.iRestCall:9: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/rest/irestcall.py:docstring of itoolkit.rest.irestcall.iRestCall:9: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/rest/irestcall.py:docstring of itoolkit.rest.irestcall.iRestCall:9: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/db2/idb2call.py:docstring of itoolkit.db2.idb2call.iDB2Call:6: ERROR: Unexpected indentation.
/home/kadler/projects/python-itoolkit/itoolkit/db2/idb2call.py:docstring of itoolkit.db2.idb2call.iDB2Call:8: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/kadler/projects/python-itoolkit/itoolkit/db2/idb2call.py:docstring of itoolkit.db2.idb2call.iDB2Call:8: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/db2/idb2call.py:docstring of itoolkit.db2.idb2call.iDB2Call:8: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/db2/idb2call.py:docstring of itoolkit.db2.idb2call.iDB2Call:8: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/db2/idb2call.py:docstring of itoolkit.db2.idb2call.iDB2Call:8: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/lib/ilibcall.py:docstring of itoolkit.lib.ilibcall.iLibCall:4: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/lib/ilibcall.py:docstring of itoolkit.lib.ilibcall.iLibCall:4: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/itoolkit/lib/ilibcall.py:docstring of itoolkit.lib.ilibcall.iLibCall:4: WARNING: Inline emphasis start-string without end-string.
/home/kadler/projects/python-itoolkit/docs/examples.rst:1: WARNING: malformed hyperlink target.

Comments (1)

  2. Log in to comment
Assignee
–
Type
bug
Priority
trivial
Status
resolved
Votes
0
Watchers
1
Jira: the preferred issue tracker for Bitbucket. Join the team!