Sphinx: No content update in html content from docstring

Created on 3 May 2017  路  15Comments  路  Source: sphinx-doc/sphinx

Subject: No content update in html content from docstring after running make html

Problem

  • No content update in html content from docstring

Procedure to reproduce the problem

make html

after updating the content of docstring in my code and running make html
there is no error in console and there is no proper content update in
built html.

Error logs / results

no error displayed

Expected results

proper update of content.

Reproducible project / your project

https://github.com/jawahar273/practNLPTools-lite

Environment info

  • OS: linux( ubutntu)
  • Python version: 3.5
  • Sphinx version: 1.5.x
autodoc question
Source
picture jawahar273

All 15 comments

IMO there are no way to obtain the last updated time of docstrings. So Sphinx could not detect the updates...
I guess rewriting docstings is happened only on developers' local.
How about using make clean html instead?

tk0miya picture tk0miya on 13 May 2017

I forgot to add one more thing there is a warning display when i use make clean html or some times
make html

docstring of pntl.tools.Annotator.getSennaTagBatch:2: WARNING: Field list ends without a blank line; unexpected unindent and one more thing what is the use of this number 2 displayed in the working.

pntl.tools.Annotator.getSennaTagBatch is a function I use in my code and if i have checked more two or three time i could not understand it

```python
def getSennaTagBatch(self, sentences):
"""Communicates with senna through lower level communiction(sub process)
and converted the console output(default is file writing).
On batch processing each end is add with new line.

    :param list sentences: list of sentences for batch processes
    :rtype: 
    """
jawahar273 picture jawahar273 on 14 May 2017

As a quick look, there are no strange notations...
Could you try with -vvv option. Then, you'll see the internal mark-ups which autodoc generates.

tk0miya picture tk0miya on 15 May 2017

could u brief that cli again 

make clean html -vvv
GNU Make 4.1
Built for x86_64-pc-linux-gnu
Copyright (C) 1988-2014 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
jawahar273 picture jawahar273 on 15 May 2017

ah, sorry. please give the option to sphinx-build command.
Through make command, you can do it with SPHINXOPTS variable:

make clean html SPHINXOPTS=-vvv
tk0miya picture tk0miya on 16 May 2017

what should i have to show you
This is a big log to show

Removing everything under '_build'...
Running Sphinx v1.5.5
making output directory...
[app] setting up extension: 'sphinx.builders.applehelp'
[app] setting up extension: 'sphinx.builders.html'
[app] adding builder: <class 'sphinx.builders.html.StandaloneHTMLBuilder'>
[app] adding builder: <class 'sphinx.builders.html.DirectoryHTMLBuilder'>
[app] adding builder: <class 'sphinx.builders.html.SingleFileHTMLBuilder'>
[app] adding builder: <class 'sphinx.builders.html.PickleHTMLBuilder'>
[app] adding builder: <class 'sphinx.builders.html.JSONHTMLBuilder'>
[app] connecting event 'builder-inited': <function validate_config_values at 0x7f114d5f8e18> [id=0]
[app] adding config value: ('html_theme', 'alabaster', 'html')
[app] adding config value: ('html_theme_path', [], 'html')
[app] adding config value: ('html_theme_options', {}, 'html')
[app] adding config value: ('html_title', <function setup.<locals>.<lambda> at 0x7f114d0c11e0>, 'html', [<class 'str'>])
[app] adding config value: ('html_short_title', <function setup.<locals>.<lambda> at 0x7f114d0c1268>, 'html')
[app] adding config value: ('html_style', None, 'html', [<class 'str'>])
[app] adding config value: ('html_logo', None, 'html', [<class 'str'>])
[app] adding config value: ('html_favicon', None, 'html', [<class 'str'>])
[app] adding config value: ('html_static_path', [], 'html')
[app] adding config value: ('html_extra_path', [], 'html')
[app] adding config value: ('html_last_updated_fmt', None, 'html', [<class 'str'>])
[app] adding config value: ('html_use_smartypants', True, 'html')
[app] adding config value: ('html_sidebars', {}, 'html')
[app] adding config value: ('html_additional_pages', {}, 'html')
[app] adding config value: ('html_use_modindex', True, 'html')
[app] adding config value: ('html_domain_indices', True, 'html', [<class 'list'>])
[app] adding config value: ('html_add_permalinks', '露', 'html')
[app] adding config value: ('html_use_index', True, 'html')
[app] adding config value: ('html_split_index', False, 'html')
[app] adding config value: ('html_copy_source', True, 'html')
[app] adding config value: ('html_show_sourcelink', True, 'html')
[app] adding config value: ('html_sourcelink_suffix', '.txt', 'html')
[app] adding config value: ('html_use_opensearch', '', 'html')
[app] adding config value: ('html_file_suffix', None, 'html', [<class 'str'>])
[app] adding config value: ('html_link_suffix', None, 'html', [<class 'str'>])
[app] adding config value: ('html_show_copyright', True, 'html')
[app] adding config value: ('html_show_sphinx', True, 'html')
[app] adding config value: ('html_context', {}, 'html')
[app] adding config value: ('html_output_encoding', 'utf-8', 'html')
[app] adding config value: ('html_compact_lists', True, 'html')
[app] adding config value: ('html_secnumber_suffix', '. ', 'html')
[app] adding config value: ('html_search_language', None, 'html', [<class 'str'>])
[app] adding config value: ('html_search_options', {}, 'html')
[app] adding config value: ('html_search_scorer', '', None)
[app] adding config value: ('html_scaled_image_link', True, 'html')
[app] adding builder: <class 'sphinx.builders.applehelp.AppleHelpBuilder'>
[app] adding config value: ('applehelp_bundle_name', <function setup.<locals>.<lambda> at 0x7f114d0c10d0>, 'applehelp')
[app] adding config value: ('applehelp_bundle_id', None, 'applehelp', [<class 'str'>])
[app] adding config value: ('applehelp_dev_region', 'en-us', 'applehelp')
[app] adding config value: ('applehelp_bundle_version', '1', 'applehelp')
[app] adding config value: ('applehelp_icon', None, 'applehelp', [<class 'str'>])
[app] adding config value: ('applehelp_kb_product', <function setup.<locals>.<lambda> at 0x7f114d0c1378>, 'applehelp')
[app] adding config value: ('applehelp_kb_url', None, 'applehelp', [<class 'str'>])
[app] adding config value: ('applehelp_remote_url', None, 'applehelp', [<class 'str'>])
[app] adding config value: ('applehelp_index_anchors', False, 'applehelp', [<class 'str'>])
[app] adding config value: ('applehelp_min_term_length', None, 'applehelp', [<class 'str'>])
[app] adding config value: ('applehelp_stopwords', <function setup.<locals>.<lambda> at 0x7f1154e64f28>, 'applehelp')
[app] adding config value: ('applehelp_locale', <function setup.<locals>.<lambda> at 0x7f114d0c1400>, 'applehelp')
[app] adding config value: ('applehelp_title', <function setup.<locals>.<lambda> at 0x7f114d0c12f0>, 'applehelp')
[app] adding config value: ('applehelp_codesign_identity', <function setup.<locals>.<lambda> at 0x7f114d0c1158>, 'applehelp')
[app] adding config value: ('applehelp_codesign_flags', <function setup.<locals>.<lambda> at 0x7f114d0c1510>, 'applehelp')
[app] adding config value: ('applehelp_indexer_path', '/usr/bin/hiutil', 'applehelp')
[app] adding config value: ('applehelp_codesign_path', '/usr/bin/codesign', 'applehelp')
[app] adding config value: ('applehelp_disable_external_tools', False, None)
[app] setting up extension: 'sphinx.builders.changes'
[app] adding builder: <class 'sphinx.builders.changes.ChangesBuilder'>
[app] setting up extension: 'sphinx.builders.epub'
[app] setting up extension: 'sphinx.builders.html'
[app] adding builder: <class 'sphinx.builders.epub.EpubBuilder'>
[app] adding config value: ('epub_basename', <function setup.<locals>.<lambda> at 0x7f114d0cf8c8>, None)
[app] adding config value: ('epub_theme', 'epub', 'html')
[app] adding config value: ('epub_theme_options', {}, 'html')
[app] adding config value: ('epub_title', <function setup.<locals>.<lambda> at 0x7f114d0cf9d8>, 'html')
[app] adding config value: ('epub_author', 'unknown', 'html')
[app] adding config value: ('epub_language', <function setup.<locals>.<lambda> at 0x7f114d0cfae8>, 'html')
[app] adding config value: ('epub_publisher', 'unknown', 'html')
[app] adding config value: ('epub_copyright', <function setup.<locals>.<lambda> at 0x7f114d0cfbf8>, 'html')
[app] adding config value: ('epub_identifier', 'unknown', 'html')
[app] adding config value: ('epub_scheme', 'unknown', 'html')
[app] adding config value: ('epub_uid', 'unknown', 'env')
[app] adding config value: ('epub_cover', (), 'env')
[app] adding config value: ('epub_guide', (), 'env')
[app] adding config value: ('epub_pre_files', [], 'env')
[app] adding config value: ('epub_post_files', [], 'env')
[app] adding config value: ('epub_exclude_files', [], 'env')
[app] adding config value: ('epub_tocdepth', 3, 'env')
[app] adding config value: ('epub_tocdup', True, 'env')
[app] adding config value: ('epub_tocscope', 'default', 'env')
[app] adding config value: ('epub_fix_images', False, 'env')
[app] adding config value: ('epub_max_image_width', 0, 'env')
[app] adding config value: ('epub_show_urls', 'inline', 'html')
[app] adding config value: ('epub_use_index', <function setup.<locals>.<lambda> at 0x7f114d0cfb70>, 'html')
[app] setting up extension: 'sphinx.builders.epub3'
[app] setting up extension: 'sphinx.builders.epub'
[app] adding builder: <class 'sphinx.builders.epub3.Epub3Builder'>
[app] connecting event 'builder-inited': <function validate_config_values at 0x7f114d0cf950> [id=1]
[app] adding config value: ('epub_description', '', 'epub3', [<class 'str'>])
[app] adding config value: ('epub_contributor', 'unknown', 'epub3', [<class 'str'>])
[app] adding config value: ('epub_writing_mode', 'horizontal', 'epub3', [<class 'str'>])
[app] adding config value: ('epub3_description', None, 'epub3', [<class 'str'>])
[app] adding config value: ('epub3_contributor', None, 'epub3', [<class 'str'>])
[app] adding config value: ('epub3_page_progression_direction', None, 'epub3', [<class 'str'>])
[app] setting up extension: 'sphinx.builders.devhelp'
[app] setting up extension: 'sphinx.builders.html'
[app] adding builder: <class 'sphinx.builders.devhelp.DevhelpBuilder'>
[app] adding config value: ('devhelp_basename', <function setup.<locals>.<lambda> at 0x7f114d0c1598>, None)
[app] setting up extension: 'sphinx.builders.dummy'
[app] adding builder: <class 'sphinx.builders.dummy.DummyBuilder'>
[app] setting up extension: 'sphinx.builders.gettext'
[app] adding builder: <class 'sphinx.builders.gettext.MessageCatalogBuilder'>
[app] adding config value: ('gettext_compact', True, 'gettext')
[app] adding config value: ('gettext_location', True, 'gettext')
[app] adding config value: ('gettext_uuid', False, 'gettext')
[app] adding config value: ('gettext_auto_build', True, 'env')
[app] adding config value: ('gettext_additional_targets', [], 'env')
[app] setting up extension: 'sphinx.builders.html'
[app] setting up extension: 'sphinx.builders.htmlhelp'
[app] setting up extension: 'sphinx.builders.html'
[app] adding builder: <class 'sphinx.builders.htmlhelp.HTMLHelpBuilder'>
[app] adding config value: ('htmlhelp_basename', <function setup.<locals>.<lambda> at 0x7f114d0cfa60>, None)
[app] setting up extension: 'sphinx.builders.latex'
[app] adding builder: <class 'sphinx.builders.latex.LaTeXBuilder'>
[app] connecting event 'builder-inited': <function validate_config_values at 0x7f114d082400> [id=2]
[app] adding config value: ('latex_engine', <function default_latex_engine at 0x7f114cdf57b8>, None, <sphinx.config.ENUM object at 0x7f114de9f550>)
[app] adding config value: ('latex_documents', <function setup.<locals>.<lambda> at 0x7f114d0822f0>, None)
[app] adding config value: ('latex_logo', None, None, [<class 'str'>])
[app] adding config value: ('latex_appendices', [], None)
[app] adding config value: ('latex_keep_old_macro_names', True, None)
[app] adding config value: ('latex_use_parts', False, None)
[app] adding config value: ('latex_toplevel_sectioning', None, None, [<class 'str'>])
[app] adding config value: ('latex_use_modindex', True, None)
[app] adding config value: ('latex_domain_indices', True, None, [<class 'list'>])
[app] adding config value: ('latex_show_urls', 'no', None)
[app] adding config value: ('latex_show_pagerefs', False, None)
[app] adding config value: ('latex_paper_size', 'letter', None)
[app] adding config value: ('latex_font_size', '10pt', None)
[app] adding config value: ('latex_elements', {}, None)
[app] adding config value: ('latex_additional_files', [], None)
[app] adding config value: ('latex_docclass', <function default_latex_docclass at 0x7f114cdf5840>, None)
[app] adding config value: ('latex_preamble', '', None)
[app] setting up extension: 'sphinx.builders.linkcheck'
[app] adding builder: <class 'sphinx.builders.linkcheck.CheckExternalLinksBuilder'>
[app] adding config value: ('linkcheck_ignore', [], None)
[app] adding config value: ('linkcheck_retries', 1, None)
[app] adding config value: ('linkcheck_timeout', None, None, [<class 'int'>])
[app] adding config value: ('linkcheck_workers', 5, None)
[app] adding config value: ('linkcheck_anchors', True, None)
[app] adding config value: ('linkcheck_anchors_ignore', ['^!'], None)
[app] setting up extension: 'sphinx.builders.manpage'
[app] adding builder: <class 'sphinx.builders.manpage.ManualPageBuilder'>
[app] adding config value: ('man_pages', <function setup.<locals>.<lambda> at 0x7f114d0821e0>, None)
[app] adding config value: ('man_show_urls', False, None)
[app] setting up extension: 'sphinx.builders.qthelp'
[app] setting up extension: 'sphinx.builders.html'
[app] adding builder: <class 'sphinx.builders.qthelp.QtHelpBuilder'>
[app] adding config value: ('qthelp_basename', <function setup.<locals>.<lambda> at 0x7f114c0e5268>, None)
[app] adding config value: ('qthelp_theme', 'nonav', 'html')
[app] adding config value: ('qthelp_theme_options', {}, 'html')
[app] setting up extension: 'sphinx.builders.texinfo'
[app] adding builder: <class 'sphinx.builders.texinfo.TexinfoBuilder'>
[app] adding config value: ('texinfo_documents', <function setup.<locals>.<lambda> at 0x7f114c0e5378>, None)
[app] adding config value: ('texinfo_appendices', [], None)
[app] adding config value: ('texinfo_elements', {}, None)
[app] adding config value: ('texinfo_domain_indices', True, None, [<class 'list'>])
[app] adding config value: ('texinfo_show_urls', 'footnote', None)
[app] adding config value: ('texinfo_no_detailmenu', False, None)
[app] setting up extension: 'sphinx.builders.text'
[app] adding builder: <class 'sphinx.builders.text.TextBuilder'>
[app] adding config value: ('text_sectionchars', '*=-~"+`', 'env')
[app] adding config value: ('text_newlines', 'unix', 'env')
[app] setting up extension: 'sphinx.builders.websupport'
[app] adding builder: <class 'sphinx.builders.websupport.WebSupportBuilder'>
[app] setting up extension: 'sphinx.builders.xml'
[app] adding builder: <class 'sphinx.builders.xml.XMLBuilder'>
[app] adding builder: <class 'sphinx.builders.xml.PseudoXMLBuilder'>
[app] adding config value: ('xml_pretty', True, 'env')
[app] setting up extension: 'sphinx.domains.c'
[app] adding domain: <class 'sphinx.domains.c.CDomain'>
[app] setting up extension: 'sphinx.domains.cpp'
[app] adding domain: <class 'sphinx.domains.cpp.CPPDomain'>
[app] adding config value: ('cpp_index_common_prefix', [], 'env')
[app] adding config value: ('cpp_id_attributes', [], 'env')
[app] adding config value: ('cpp_paren_attributes', [], 'env')
[app] setting up extension: 'sphinx.domains.javascript'
[app] adding domain: <class 'sphinx.domains.javascript.JavaScriptDomain'>
[app] setting up extension: 'sphinx.domains.python'
[app] adding domain: <class 'sphinx.domains.python.PythonDomain'>
[app] setting up extension: 'sphinx.domains.rst'
[app] adding domain: <class 'sphinx.domains.rst.ReSTDomain'>
[app] setting up extension: 'sphinx.domains.std'
[app] adding domain: <class 'sphinx.domains.std.StandardDomain'>
[app] setting up extension: 'sphinx.directives'
[app] setting up extension: 'sphinx.directives.code'
[app] setting up extension: 'sphinx.directives.other'
[app] setting up extension: 'sphinx.directives.patches'
[app] setting up extension: 'sphinx.roles'
[app] setting up extension: 'sphinx.ext.coverage'
[app] adding builder: <class 'sphinx.ext.coverage.CoverageBuilder'>
[app] adding config value: ('coverage_ignore_modules', [], False)
[app] adding config value: ('coverage_ignore_functions', [], False)
[app] adding config value: ('coverage_ignore_classes', [], False)
[app] adding config value: ('coverage_c_path', [], False)
[app] adding config value: ('coverage_c_regexes', {}, False)
[app] adding config value: ('coverage_ignore_c_items', {}, False)
[app] adding config value: ('coverage_write_headline', True, False)
[app] adding config value: ('coverage_skip_undoc_in_source', False, False)
[app] setting up extension: 'sphinx.ext.autodoc'
[app] adding autodocumenter: <class 'sphinx.ext.autodoc.ModuleDocumenter'>
[app] adding directive: ('automodule', <class 'sphinx.ext.autodoc.AutoDirective'>, None, None, {})
[app] adding autodocumenter: <class 'sphinx.ext.autodoc.ClassDocumenter'>
[app] adding directive: ('autoclass', <class 'sphinx.ext.autodoc.AutoDirective'>, None, None, {})
[app] adding autodocumenter: <class 'sphinx.ext.autodoc.ExceptionDocumenter'>
[app] adding directive: ('autoexception', <class 'sphinx.ext.autodoc.AutoDirective'>, None, None, {})
[app] adding autodocumenter: <class 'sphinx.ext.autodoc.DataDocumenter'>
[app] adding directive: ('autodata', <class 'sphinx.ext.autodoc.AutoDirective'>, None, None, {})
[app] adding autodocumenter: <class 'sphinx.ext.autodoc.FunctionDocumenter'>
[app] adding directive: ('autofunction', <class 'sphinx.ext.autodoc.AutoDirective'>, None, None, {})
[app] adding autodocumenter: <class 'sphinx.ext.autodoc.MethodDocumenter'>
[app] adding directive: ('automethod', <class 'sphinx.ext.autodoc.AutoDirective'>, None, None, {})
[app] adding autodocumenter: <class 'sphinx.ext.autodoc.AttributeDocumenter'>
[app] adding directive: ('autoattribute', <class 'sphinx.ext.autodoc.AutoDirective'>, None, None, {})
[app] adding autodocumenter: <class 'sphinx.ext.autodoc.InstanceAttributeDocumenter'>
[app] adding directive: ('autoinstanceattribute', <class 'sphinx.ext.autodoc.AutoDirective'>, None, None, {})
[app] adding config value: ('autoclass_content', 'class', True)
[app] adding config value: ('autodoc_member_order', 'alphabetic', True)
[app] adding config value: ('autodoc_default_flags', [], True)
[app] adding config value: ('autodoc_docstring_signature', True, True)
[app] adding config value: ('autodoc_mock_imports', [], True)
[app] adding event: 'autodoc-process-docstring'
[app] adding event: 'autodoc-process-signature'
[app] adding event: 'autodoc-skip-member'
[app] setting up extension: 'alabaster'
[app] connecting event 'html-page-context': <function update_context at 0x7f114bff5488> [id=3]
loading pickled environment... not yet created
[app] emitting event: 'builder-inited'()
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 3 source files that are out of date
updating environment: [app] emitting event: 'env-get-outdated'(<sphinx.environment.BuildEnvironment object at 0x7f114bfee630>, {'modules', 'index', 'pntl'}, set()
3 added, 0 changed, 0 removed
[app] emitting event: 'env-before-read-docs'(<sphinx.environment.BuildEnvironment object at 0x7f114bfee630>, ['index', 'modules', 'pntl'])
reading sources... [ 33%] index
[app] emitting event: 'env-purge-doc'(<sphinx.environment.BuildEnvironment object at 0x7f114bfee630>, 'index')
[app] emitting event: 'source-read'('index', [".. practnlptools-lite documentation master file, created by\n   sphinx-quickstart on Wed
[app] emitting event: 'doctree-read'(<document: <comment...><section "welcome to practnlptools-lite's do ...>,)
reading sources... [ 66%] modules
[app] emitting event: 'env-purge-doc'(<sphinx.environment.BuildEnvironment object at 0x7f114bfee630>, 'modules')
[app] emitting event: 'source-read'('modules', ['pntl\n====\n\n.. toctree::\n   :maxdepth: 4\n\n   pntl\n'])
[app] emitting event: 'doctree-read'(<document: <section "pntl"...>>,)
reading sources... [100%] pntl
[app] emitting event: 'env-purge-doc'(<sphinx.environment.BuildEnvironment object at 0x7f114bfee630>, 'pntl')
[app] emitting event: 'source-read'('pntl', ['pntl package\n============\n\nSubmodules\n----------\n\npntl\\.tools module\n------------
[autodoc] /media/jawahar/jon/ubuntu/practNLPTools-lite/api/pntl.rst:10: input:
.. automodule:: pntl.tools
    :members:
    :undoc-members:
    :show-inheritance:

[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[app] emitting event: 'autodoc-process-signature'('module', 'pntl.tools', <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packa
[app] emitting event: 'autodoc-process-docstring'('module', 'pntl.tools', <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packa
[app] emitting event: 'autodoc-skip-member'('module', 'Annotator', <class 'pntl.tools.Annotator'>, False, {'show-inheritance': True, 'members':
[app] emitting event: 'autodoc-skip-member'('module', '__builtins__', {'SyntaxError': <class 'SyntaxError'>, 'map': <class 'map'>, 'print': <bu
[app] emitting event: 'autodoc-skip-member'('module', '__cached__', '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/__pycache__/tools
[app] emitting event: 'autodoc-skip-member'('module', '__doc__', '\nA module for interfacing with the SENNA and Stanford Dependency Extractor.\
[app] emitting event: 'autodoc-skip-member'('module', '__file__', '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py', True, {'
[app] emitting event: 'autodoc-skip-member'('module', '__loader__', <_frozen_importlib_external.SourceFileLoader object at 0x7f114bea7fd0>, Tru
[app] emitting event: 'autodoc-skip-member'('module', '__name__', 'pntl.tools', True, {'show-inheritance': True, 'members': <object object at 0
[app] emitting event: 'autodoc-skip-member'('module', '__package__', 'pntl', True, {'show-inheritance': True, 'members': <object object at 0x7f
[app] emitting event: 'autodoc-skip-member'('module', '__spec__', ModuleSpec(name='pntl.tools', loader=<_frozen_importlib_external.SourceFileLo
[app] emitting event: 'autodoc-skip-member'('module', 'architecture', <function architecture at 0x7f114dba48c8>, False, {'show-inheritance': Tr
[app] emitting event: 'autodoc-skip-member'('module', 'generators', _Feature((2, 2, 0, 'alpha', 1), (2, 3, 0, 'final', 0), 0), False, {'show-in
[app] emitting event: 'autodoc-skip-member'('module', 'os', <module 'os' from '/home/jawahar/anaconda3/lib/python3.5/os.py'>, False, {'show-inh
[app] emitting event: 'autodoc-skip-member'('module', 'print_function', _Feature((2, 6, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 65536), False, {
[app] emitting event: 'autodoc-skip-member'('module', 'subprocess', <module 'subprocess' from '/home/jawahar/anaconda3/lib/python3.5/subprocess
[app] emitting event: 'autodoc-skip-member'('module', 'system', <function system at 0x7f114dba4e18>, False, {'show-inheritance': True, 'members
[app] emitting event: 'autodoc-skip-member'('module', 'test', <function test at 0x7f114be81730>, False, {'show-inheritance': True, 'members': <
[app] emitting event: 'autodoc-skip-member'('module', 'unicode_literals', _Feature((2, 6, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 131072), False
[autodoc] from pntl.tools import Annotator
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'Annotator')
[autodoc] => <class 'pntl.tools.Annotator'>
[app] emitting event: 'autodoc-process-signature'('class', 'pntl.tools.Annotator', <class 'pntl.tools.Annotator'>, {'show-inheritance': True, 'member
[app] emitting event: 'autodoc-process-docstring'('class', 'pntl.tools.Annotator', <class 'pntl.tools.Annotator'>, {'show-inheritance': True, 'member
[app] emitting event: 'autodoc-skip-member'('class', '__dict__', mappingproxy({'getBatchAnnotations': <function Annotator.getBatchAnnotations a
[app] emitting event: 'autodoc-skip-member'('class', '__doc__', '\n    A general interface of the SENNA/Stanford Dependency Extractor pipeline 
[app] emitting event: 'autodoc-skip-member'('class', '__init__', <function Annotator.__init__ at 0x7f114be817b8>, True, {'show-inheritance': Tr
[app] emitting event: 'autodoc-skip-member'('class', '__module__', 'pntl.tools', True, {'show-inheritance': True, 'members': <object object at 
[app] emitting event: 'autodoc-skip-member'('class', '__weakref__', <attribute '__weakref__' of 'Annotator' objects>, True, {'show-inheritance'
[app] emitting event: 'autodoc-skip-member'('class', 'getAnnotations', <function Annotator.getAnnotations at 0x7f114be81ea0>, False, {'show-inh
[app] emitting event: 'autodoc-skip-member'('class', 'getBatchAnnotations', <function Annotator.getBatchAnnotations at 0x7f114be81e18>, False, 
[app] emitting event: 'autodoc-skip-member'('class', 'getDependency', <function Annotator.getDependency at 0x7f114be81d90>, False, {'show-inher
[app] emitting event: 'autodoc-skip-member'('class', 'getSennaTag', <function Annotator.getSennaTag at 0x7f114be81d08>, False, {'show-inheritan
[app] emitting event: 'autodoc-skip-member'('class', 'getSennaTagBatch', <function Annotator.getSennaTagBatch at 0x7f114be81c80>, False, {'show
[app] emitting event: 'autodoc-skip-member'('class', 'get_cos_name', <function Annotator.get_cos_name at 0x7f114be81bf8>, False, {'show-inherit
[app] emitting event: 'autodoc-skip-member'('class', 'jar_clr', <property object at 0x7f114be44228>, False, {'show-inheritance': True, 'members
[app] emitting event: 'autodoc-skip-member'('class', 'print_values', <function Annotator.print_values at 0x7f114be81840>, False, {'show-inherit
[app] emitting event: 'autodoc-skip-member'('class', 'senna_chdir', <property object at 0x7f114be441d8>, False, {'show-inheritance': True, 'mem
[app] emitting event: 'autodoc-skip-member'('class', 'stp_chdir', <property object at 0x7f114be44188>, False, {'show-inheritance': True, 'membe
[autodoc] from pntl.tools import Annotator.getAnnotations
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'Annotator')
[autodoc] => <class 'pntl.tools.Annotator'>
[autodoc] getattr(_, 'getAnnotations')
[autodoc] => <function Annotator.getAnnotations at 0x7f114be81ea0>
[app] emitting event: 'autodoc-process-signature'('method', 'pntl.tools.Annotator.getAnnotations', <function Annotator.getAnnotations at 0x7f114be81e
[app] emitting event: 'autodoc-process-docstring'('method', 'pntl.tools.Annotator.getAnnotations', <function Annotator.getAnnotations at 0x7f114be81e
[autodoc] from pntl.tools import Annotator.getBatchAnnotations
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'Annotator')
[autodoc] => <class 'pntl.tools.Annotator'>
[autodoc] getattr(_, 'getBatchAnnotations')
[autodoc] => <function Annotator.getBatchAnnotations at 0x7f114be81e18>
[app] emitting event: 'autodoc-process-signature'('method', 'pntl.tools.Annotator.getBatchAnnotations', <function Annotator.getBatchAnnotations at 0x
[app] emitting event: 'autodoc-process-docstring'('method', 'pntl.tools.Annotator.getBatchAnnotations', <function Annotator.getBatchAnnotations at 0x
[autodoc] from pntl.tools import Annotator.getDependency
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'Annotator')
[autodoc] => <class 'pntl.tools.Annotator'>
[autodoc] getattr(_, 'getDependency')
[autodoc] => <function Annotator.getDependency at 0x7f114be81d90>
[app] emitting event: 'autodoc-process-signature'('method', 'pntl.tools.Annotator.getDependency', <function Annotator.getDependency at 0x7f114be81d90
[app] emitting event: 'autodoc-process-docstring'('method', 'pntl.tools.Annotator.getDependency', <function Annotator.getDependency at 0x7f114be81d90
[autodoc] from pntl.tools import Annotator.getSennaTag
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'Annotator')
[autodoc] => <class 'pntl.tools.Annotator'>
[autodoc] getattr(_, 'getSennaTag')
[autodoc] => <function Annotator.getSennaTag at 0x7f114be81d08>
[app] emitting event: 'autodoc-process-signature'('method', 'pntl.tools.Annotator.getSennaTag', <function Annotator.getSennaTag at 0x7f114be81d08>, {
[app] emitting event: 'autodoc-process-docstring'('method', 'pntl.tools.Annotator.getSennaTag', <function Annotator.getSennaTag at 0x7f114be81d08>, {
[autodoc] from pntl.tools import Annotator.getSennaTagBatch
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'Annotator')
[autodoc] => <class 'pntl.tools.Annotator'>
[autodoc] getattr(_, 'getSennaTagBatch')
[autodoc] => <function Annotator.getSennaTagBatch at 0x7f114be81c80>
[app] emitting event: 'autodoc-process-signature'('method', 'pntl.tools.Annotator.getSennaTagBatch', <function Annotator.getSennaTagBatch at 0x7f114b
[app] emitting event: 'autodoc-process-docstring'('method', 'pntl.tools.Annotator.getSennaTagBatch', <function Annotator.getSennaTagBatch at 0x7f114b
[autodoc] from pntl.tools import Annotator.get_cos_name
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'Annotator')
[autodoc] => <class 'pntl.tools.Annotator'>
[autodoc] getattr(_, 'get_cos_name')
[autodoc] => <function Annotator.get_cos_name at 0x7f114be81bf8>
[app] emitting event: 'autodoc-process-signature'('method', 'pntl.tools.Annotator.get_cos_name', <function Annotator.get_cos_name at 0x7f114be81bf8>,
[app] emitting event: 'autodoc-process-docstring'('method', 'pntl.tools.Annotator.get_cos_name', <function Annotator.get_cos_name at 0x7f114be81bf8>,
[autodoc] from pntl.tools import Annotator.jar_clr
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'Annotator')
[autodoc] => <class 'pntl.tools.Annotator'>
[autodoc] getattr(_, 'jar_clr')
[autodoc] => <property object at 0x7f114be44228>
[app] emitting event: 'autodoc-process-signature'('attribute', 'pntl.tools.Annotator.jar_clr', <property object at 0x7f114be44228>, {'show-inheritanc
[app] emitting event: 'autodoc-process-docstring'('attribute', 'pntl.tools.Annotator.jar_clr', <property object at 0x7f114be44228>, {'show-inheritanc
[autodoc] from pntl.tools import Annotator.print_values
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'Annotator')
[autodoc] => <class 'pntl.tools.Annotator'>
[autodoc] getattr(_, 'print_values')
[autodoc] => <function Annotator.print_values at 0x7f114be81840>
[app] emitting event: 'autodoc-process-signature'('method', 'pntl.tools.Annotator.print_values', <function Annotator.print_values at 0x7f114be81840>,
[app] emitting event: 'autodoc-process-docstring'('method', 'pntl.tools.Annotator.print_values', <function Annotator.print_values at 0x7f114be81840>,
[autodoc] from pntl.tools import Annotator.senna_chdir
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'Annotator')
[autodoc] => <class 'pntl.tools.Annotator'>
[autodoc] getattr(_, 'senna_chdir')
[autodoc] => <property object at 0x7f114be441d8>
[app] emitting event: 'autodoc-process-signature'('attribute', 'pntl.tools.Annotator.senna_chdir', <property object at 0x7f114be441d8>, {'show-inheri
[app] emitting event: 'autodoc-process-docstring'('attribute', 'pntl.tools.Annotator.senna_chdir', <property object at 0x7f114be441d8>, {'show-inheri
[autodoc] from pntl.tools import Annotator.stp_chdir
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'Annotator')
[autodoc] => <class 'pntl.tools.Annotator'>
[autodoc] getattr(_, 'stp_chdir')
[autodoc] => <property object at 0x7f114be44188>
[app] emitting event: 'autodoc-process-signature'('attribute', 'pntl.tools.Annotator.stp_chdir', <property object at 0x7f114be44188>, {'show-inherita
[app] emitting event: 'autodoc-process-docstring'('attribute', 'pntl.tools.Annotator.stp_chdir', <property object at 0x7f114be44188>, {'show-inherita
[autodoc] from pntl.tools import architecture
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'architecture')
[autodoc] => <function architecture at 0x7f114dba48c8>
[autodoc] from pntl.tools import system
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'system')
[autodoc] => <function system at 0x7f114dba4e18>
[autodoc] from pntl.tools import test
[autodoc] import pntl.tools
[autodoc] => <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py'>
[autodoc] getattr(_, 'test')
[autodoc] => <function test at 0x7f114be81730>
[app] emitting event: 'autodoc-process-signature'('function', 'pntl.tools.test', <function test at 0x7f114be81730>, {'show-inheritance': True, 'membe
[app] emitting event: 'autodoc-process-docstring'('function', 'pntl.tools.test', <function test at 0x7f114be81730>, {'show-inheritance': True, 'membe
[autodoc] output:

.. py:module:: pntl.tools

A module for interfacing with the SENNA and Stanford Dependency Extractor.
SUPPORTED_OPERATIONS: It provides
Part of Speech Tags,
Semantic Role Labels,
Shallow Parsing (Chunking),
Named Entity Recognisation (NER),
Dependency Parse and
Syntactic Constituency Parse.
Skip Gram
Requirement: Java Runtime Environment :)


.. py:class:: Annotator(senna_path='', dep_model='')
   :module: pntl.tools

   Bases: :class:`object`

   A general interface of the SENNA/Stanford Dependency Extractor pipeline that supports any of the
   operations specified in SUPPORTED_OPERATIONS.
   SUPPORTED_OPERATIONS: It provides
   Part of Speech Tags,
    Semantic Role Labels,
   Shallow Parsing (Chunking),
   Named Entity Recognisation (NER), 
   Dependency Parse 
   and
   Syntactic Constituency Parse.
   Applying multiple operations at once has the speed advantage. For example,
   senna v3.0 will calculate the POS tags in case you are extracting the named
   entities. Applying both of the operations will cost only the time of
   extracting the named entities. Same is true for dependency Parsing.
   SENNA pipeline has a fixed maximum size of the sentences that it can read.
   By default it is 1024 token/sentence. If you have larger sentences, changing
   the MAX_SENTENCE_SIZE value in SENNA_main.c should be considered and your
   system specific binary should be rebuilt. Otherwise this could introduce
   misalignment errors.


   .. py:method:: Annotator.getAnnotations(sentence='', senna_tags=None, batch=False, dep_parse=True)
      :module: pntl.tools

      :sentence: a sentence string
      passing the string to senna and performing aboue given process 
      and the returning them in a form of `Dict()`


   .. py:method:: Annotator.getBatchAnnotations(sentences, dep_parse=True)
      :module: pntl.tools


   .. py:method:: Annotator.getDependency(parse)
      :module: pntl.tools

      :parse: parse is the input(tree format) and it is writen in as file
      change to the Stanford parser direction and process the works


   .. py:method:: Annotator.getSennaTag(sentence)
      :module: pntl.tools

      :sentence: a sentence string 
      Communicates with senna through lower level communiction(sub process)
      and converted the console output(default is file writing)


   .. py:method:: Annotator.getSennaTagBatch(sentences)
      :module: pntl.tools

      :sentences: list of sentences for batch processes
      Communicates with senna through lower level communiction(sub process)
      and converted the console output(default is file writing).
      On batch processing each end is add with new line.


   .. py:method:: Annotator.get_cos_name(os_name)
      :module: pntl.tools

      "
      get the executable binary with respect to the Os name.


   .. py:attribute:: Annotator.jar_clr
      :module: pntl.tools


   .. py:method:: Annotator.print_values()
      :module: pntl.tools


   .. py:attribute:: Annotator.senna_chdir
      :module: pntl.tools

      The return the path of senna location
      and set the path for senna at run time


   .. py:attribute:: Annotator.stp_chdir
      :module: pntl.tools

      The return the path of senna location
      and set the path for senna at run time


.. py:function:: test(senna_path='/media/jawahar/jon/ubuntu/senna', sent='', dep_model='', batch=False)
   :module: pntl.tools

   please replace the path of yours environment(accouding to OS path)
   :senna_path: path for senna location
   :dep_model: stanford dependency parser model location

[autodoc] /media/jawahar/jon/ubuntu/practNLPTools-lite/api/pntl.rst:18: input:
.. automodule:: pntl.utils
    :members:
    :undoc-members:
    :show-inheritance:


[autodoc] import pntl.utils
[autodoc] => <module 'pntl.utils' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/utils.py'>
[app] emitting event: 'autodoc-process-signature'('module', 'pntl.utils', <module 'pntl.utils' from '/home/jawahar/anaconda3/lib/python3.5/site-packa
[app] emitting event: 'autodoc-process-docstring'('module', 'pntl.utils', <module 'pntl.utils' from '/home/jawahar/anaconda3/lib/python3.5/site-packa
[app] emitting event: 'autodoc-skip-member'('module', '__builtins__', {'SyntaxError': <class 'SyntaxError'>, 'map': <class 'map'>, 'print': <bu
[app] emitting event: 'autodoc-skip-member'('module', '__cached__', '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/__pycache__/utils
[app] emitting event: 'autodoc-skip-member'('module', '__doc__', None, True, {'show-inheritance': True, 'members': <object object at 0x7f1154eb
[app] emitting event: 'autodoc-skip-member'('module', '__file__', '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/utils.py', True, {'
[app] emitting event: 'autodoc-skip-member'('module', '__loader__', <_frozen_importlib_external.SourceFileLoader object at 0x7f114bdaa3c8>, Tru
[app] emitting event: 'autodoc-skip-member'('module', '__name__', 'pntl.utils', True, {'show-inheritance': True, 'members': <object object at 0
[app] emitting event: 'autodoc-skip-member'('module', '__package__', 'pntl', True, {'show-inheritance': True, 'members': <object object at 0x7f
[app] emitting event: 'autodoc-skip-member'('module', '__spec__', ModuleSpec(name='pntl.utils', loader=<_frozen_importlib_external.SourceFileLo
[app] emitting event: 'autodoc-skip-member'('module', 'chain', <class 'itertools.chain'>, False, {'show-inheritance': True, 'members': <object 
[app] emitting event: 'autodoc-skip-member'('module', 'combinations', <class 'itertools.combinations'>, False, {'show-inheritance': True, 'memb
[app] emitting event: 'autodoc-skip-member'('module', 'copy', <module 'copy' from '/home/jawahar/anaconda3/lib/python3.5/copy.py'>, False, {'sh
[app] emitting event: 'autodoc-skip-member'('module', 'generators', _Feature((2, 2, 0, 'alpha', 1), (2, 3, 0, 'final', 0), 0), False, {'show-in
[app] emitting event: 'autodoc-skip-member'('module', 'pad_sequence', <function pad_sequence at 0x7f114be61510>, False, {'show-inheritance': Tr
[app] emitting event: 'autodoc-skip-member'('module', 'print_function', _Feature((2, 6, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 65536), False, {
[app] emitting event: 'autodoc-skip-member'('module', 'skipgrams', <function skipgrams at 0x7f114be61488>, False, {'show-inheritance': True, 'm
[app] emitting event: 'autodoc-skip-member'('module', 'unicode_literals', _Feature((2, 6, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 131072), False
[autodoc] from pntl.utils import chain
[autodoc] import pntl.utils
[autodoc] => <module 'pntl.utils' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/utils.py'>
[autodoc] getattr(_, 'chain')
[autodoc] => <class 'itertools.chain'>
[autodoc] from pntl.utils import combinations
[autodoc] import pntl.utils
[autodoc] => <module 'pntl.utils' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/utils.py'>
[autodoc] getattr(_, 'combinations')
[autodoc] => <class 'itertools.combinations'>
[autodoc] from pntl.utils import pad_sequence
[autodoc] import pntl.utils
[autodoc] => <module 'pntl.utils' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/utils.py'>
[autodoc] getattr(_, 'pad_sequence')
[autodoc] => <function pad_sequence at 0x7f114be61510>
[app] emitting event: 'autodoc-process-signature'('function', 'pntl.utils.pad_sequence', <function pad_sequence at 0x7f114be61510>, {'show-inheritanc
[app] emitting event: 'autodoc-process-docstring'('function', 'pntl.utils.pad_sequence', <function pad_sequence at 0x7f114be61510>, {'show-inheritanc
[autodoc] from pntl.utils import skipgrams
[autodoc] import pntl.utils
[autodoc] => <module 'pntl.utils' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/utils.py'>
[autodoc] getattr(_, 'skipgrams')
[autodoc] => <function skipgrams at 0x7f114be61488>
[app] emitting event: 'autodoc-process-signature'('function', 'pntl.utils.skipgrams', <function skipgrams at 0x7f114be61488>, {'show-inheritance': Tr
[app] emitting event: 'autodoc-process-docstring'('function', 'pntl.utils.skipgrams', <function skipgrams at 0x7f114be61488>, {'show-inheritance': Tr
[autodoc] output:

.. py:module:: pntl.utils


.. py:function:: pad_sequence(sequence, n, pad_left=False, pad_right=False, pad_symbol=None)
   :module: pntl.utils


.. py:function:: skipgrams(sequence, n=2, k=1, pad_left=False, pad_right=False, pad_symbol=None)
   :module: pntl.utils

[autodoc] /media/jawahar/jon/ubuntu/practNLPTools-lite/api/pntl.rst:27: input:
.. automodule:: pntl
    :members:
    :undoc-members:
    :show-inheritance:
[autodoc] import pntl
[autodoc] => <module 'pntl' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/__init__.py'>
[app] emitting event: 'autodoc-process-signature'('module', 'pntl', <module 'pntl' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/__i
[app] emitting event: 'autodoc-process-docstring'('module', 'pntl', <module 'pntl' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/__i
[app] emitting event: 'autodoc-skip-member'('module', 'tools', <module 'pntl.tools' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/p
[app] emitting event: 'autodoc-skip-member'('module', 'utils', <module 'pntl.utils' from '/home/jawahar/anaconda3/lib/python3.5/site-packages/p
[autodoc] output:

.. py:module:: pntl

/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator:5: (ERROR/3) Unexpected indentation. [filtered system message]
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator:6: (WARNING/2) Block quote ends without a blank line; unexpected unindent. [filtered system message]
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator.getAnnotations:2: (WARNING/2) Field list ends without a blank line; unexpected unindent. [filtered system message]
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator.getDependency:2: (WARNING/2) Field list ends without a blank line; unexpected unindent. [filtered system message]
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator.getSennaTag:2: (WARNING/2) Field list ends without a blank line; unexpected unindent. [filtered system message]
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator.getSennaTagBatch:2: (WARNING/2) Field list ends without a blank line; unexpected unindent. [filtered system message]
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator.get_cos_name:1: (INFO/1) Unexpected possible title overline or transition.
Treating it as ordinary text because it's so short. [filtered system message]
[app] emitting event: 'doctree-read'(<document: <section "pntl package"...>>,)

[app] emitting event: 'env-updated'(<sphinx.environment.BuildEnvironment object at 0x7f114bfee630>,)
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator:5: ERROR: Unexpected indentation.
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator:6: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator.getAnnotations:2: WARNING: Field list ends without a blank line; unexpected unindent.
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator.getDependency:2: WARNING: Field list ends without a blank line; unexpected unindent.
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator.getSennaTag:2: WARNING: Field list ends without a blank line; unexpected unindent.
/home/jawahar/anaconda3/lib/python3.5/site-packages/pntl/tools.py:docstring of pntl.tools.Annotator.getSennaTagBatch:2: WARNING: Field list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
docnames to write: index, modules, pntl
preparing documents... done
writing output... [ 33%] index
[app] emitting event: 'doctree-resolved'(<document: <comment...><section "welcome to practnlptools-lite's do ...>, 'index')
[app] emitting event: 'html-page-context'('index', 'page.html', {'theme_footnote_border': '', 'theme_warn_border': '', 'theme_footnote_bg': '
writing output... [ 66%] modules
[app] emitting event: 'doctree-resolved'(<document: <section "pntl"...>>, 'modules')
[app] emitting event: 'html-page-context'('modules', 'page.html', {'theme_footnote_border': '', 'theme_warn_border': '', 'theme_footnote_bg':
writing output... [100%] pntl
[app] emitting event: 'missing-reference'(<sphinx.environment.BuildEnvironment object at 0x7f114bfee630>, <pending_xref: <literal...>>, <lite
[app] emitting event: 'doctree-resolved'(<document: <section "pntl package"...>>, 'pntl')
[app] emitting event: 'html-page-context'('pntl', 'page.html', {'theme_footnote_border': '', 'theme_warn_border': '', 'theme_footnote_bg': '#

generating indices... genindex[app] emitting event: 'html-page-context'('genindex', 'genindex.html', {'theme_footnote_border': '', 'theme_warn_border': '', 'theme_footnote
 py-modindex[app] emitting event: 'html-page-context'('py-modindex', 'domainindex.html', {'theme_footnote_border': '', 'theme_warn_border': '', 'theme_fo

[app] emitting event: 'html-collect-pages'()
writing additional pages... search[app] emitting event: 'html-page-context'('search', 'search.html', {'theme_footnote_border': '', 'theme_warn_border': '', 'theme_footnote_bg'

copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 6 warnings.
[app] emitting event: 'build-finished'(None,)

Build finished. The HTML pages are in _build/html.
jawahar273 picture jawahar273 on 16 May 2017

getSennaTagBatch is rendered as following.

   .. py:method:: Annotator.getSennaTagBatch(sentences)
      :module: pntl.tools

      :sentences: list of sentences for batch processes
      Communicates with senna through lower level communiction(sub process)
      and converted the console output(default is file writing).
      On batch processing each end is add with new line.

Certainly, it contains a field list which ends without a blank line.
We need to know where this field list comes from. Do you know it?

tk0miya picture tk0miya on 16 May 2017

i am sry, i am new to this but i can provide links of my projects
practNLPTools-lite,
Annotator.getSennaTagBatch
and index.rst, pntl.rst, modules.rst

jawahar273 picture jawahar273 on 19 May 2017
😕1

I have something similar to this problem, running _make clean html_ does not update the text in the html. It still uses an old installation of the source, even though I have removed and reinstalled my package.

Do sphinx have a hidden cache somewhere (except for in .build)?

Ydmir picture Ydmir on 19 May 2017
👍1

Exactly each time I execute 'make html' it gives same content even if I update the doc string

jawahar273 picture jawahar273 on 19 May 2017

I tried in clean environment. But I could not reproduce the error.

$ docker run -it --rm tk0miya/sphinx-html /bin/bash
# git clone https://github.com/jawahar273/practNLPTools-lite
# cd practNLPTools-lite/
# python3 setup.py install
(snip)
# cd api/
# make html
Running Sphinx v1.6.1
loading pickled environment... failed: build environment version not current
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 3 source files that are out of date
updating environment: 3 added, 0 changed, 0 removed
reading sources... [100%] pntl
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] pntl
generating indices... genindex py-modindex
writing additional pages... search
copying static files... WARNING: html_static_path entry '/docs/practNLPTools-lite/api/_static' does not exist
done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 1 warning.

Build finished. The HTML pages are in _build/html.

I also tested with v1.5.6:

# make clean html
Removing everything under '_build'...
Running Sphinx v1.5.6
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 3 source files that are out of date
updating environment: 3 added, 0 changed, 0 removed
reading sources... [100%] pntl
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] pntl
generating indices... genindex py-modindex
writing additional pages... search
copying static files... WARNING: html_static_path entry '/docs/practNLPTools-lite/api/_static' does not exist
done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 1 warning.

Build finished. The HTML pages are in _build/html.

With -vvv option, it generates following mark-ups internally.

   .. py:method:: Annotator.getSennaTag(sentence)
      :module: pntl.tools

      Communicates with senna through lower level communiction(sub process)
      and converted the console output(default is file writing)

      :param str or listsentences: list of sentences for batch processes
      :return: senna tagged output
      :rtype: str
tk0miya picture tk0miya on 25 May 2017

pls run this one make clean html and see if there is any warning

jawahar273 picture jawahar273 on 25 May 2017

I also couldn't see any warning for the command.

tk0miya picture tk0miya on 25 May 2017 
def test(senna_path="/media/jawahar/jon/ubuntu/senna", sent="", dep_model="", batch=False, 
               jar_path="/media/jawahar/jon/ubuntu/practNLPTools-lite/pntl"):
    """please replace the path of yours environment(accouding to OS path)
    :parama str senna_path: path for senna location
    :parama str dep_model: stanford dependency parser model location
    :parama str or list sent: the sentense to process with Senna
    :parama bool batch: makeing as batch process with one or more sentense passing
    :parama str jar_path: location of stanford-parser.jar file
    """

The about code is a function with update string and pic shown is the result after the update of the string in the function.
If your result is good as shown like ( test() ) with update string then my system might have some problems.
screenshot from 2017-05-25 21-21-32

jawahar273 picture jawahar273 on 25 May 2017

Thanq for your timing. I will look what is the problem in my code.

jawahar273 picture jawahar273 on 26 May 2017
Was this page helpful?
0 / 5 - 0 ratings

Related issues

ubershmekel picture ubershmekel  路  3Comments
dvorapa picture dvorapa  路  3Comments
susmita1d picture susmita1d  路  3Comments
pgjones picture pgjones  路  3Comments
jessetan picture jessetan  路  3Comments