Sphinx build error

[cdeil]

With Python 3.4 and Sphinx 1.3 I get the following error when I try to build the numdifftools docs:

$ python setup.py build_sphinx
/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/setuptools/dist.py:291: UserWarning: The version specified ('unknown') is an invalid version, this may not work as expected with newer versions of setuptools, pip, and PyPI. Please see PEP 440 for more details.
  "details." % self.metadata.version
running build_sphinx
Running Sphinx v1.3
Creating file /Users/deil/code/numdifftools/docs/../docs/_rst/numdifftools.rst.
Creating file /Users/deil/code/numdifftools/docs/../docs/_rst/numdifftools.tests.rst.
Creating file /Users/deil/code/numdifftools/docs/../docs/_rst/modules.rst.
Traceback (most recent call last):
  File "setup.py", line 229, in <module>
    setup_package()
  File "setup.py", line 226, in setup_package
    entry_points={'console_scripts': CONSOLE_SCRIPTS})
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/core.py", line 148, in setup
    dist.run_commands()
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/dist.py", line 955, in run_commands
    self.run_command(cmd)
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/dist.py", line 974, in run_command
    cmd_obj.run()
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/setup_command.py", line 161, in run
    freshenv=self.fresh_env)
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/application.py", line 143, in __init__
    self.setup_extension(extension)
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/application.py", line 440, in setup_extension
    ext_meta = mod.setup(self)
  File "/Users/deil/Library/Python/3.4/lib/python/site-packages/numpydoc/numpydoc.py", line 114, in setup
    app.connect('autodoc-process-docstring', mangle_docstrings)
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/application.py", line 471, in connect
    self._validate_event(event)
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/application.py", line 468, in _validate_event
    raise ExtensionError('Unknown event name: %s' % event)
sphinx.errors.ExtensionError: Unknown event name: autodoc-process-docstring

cc @maniteja123

[cdeil]

@maniteja123 Another thing ... the benchmarks currently don't run under Python 3:

Extracting numdifftools-unknown-py3.4.egg to /Users/deil/Library/Python/3.4/lib/python/site-packages
  File "/Users/deil/Library/Python/3.4/lib/python/site-packages/numdifftools-unknown-py3.4.egg/numdifftools/run_benchmark.py", line 46
    print 'N=', N
             ^
SyntaxError: Missing parentheses in call to 'print'

[pbrod]

Hi,

Thanks. I have fixed this in the new version on github.

Per A.

On 19 March 2015 at 17:53, Christoph Deil notifications@github.com wrote:

@maniteja123 https://github.com/maniteja123 Another thing ... the
benchmarks currently don't run under Python 3:

Extracting numdifftools-unknown-py3.4.egg to /Users/deil/Library/Python/3.4/lib/python/site-packages
File "/Users/deil/Library/Python/3.4/lib/python/site-packages/numdifftools-unknown-py3.4.egg/numdifftools/run_benchmark.py", line 46
print 'N=', N
^
SyntaxError: Missing parentheses in call to 'print'

—
Reply to this email directly or view it on GitHub
#2 (comment).

[pbrod]

I discovered the same. I am not sure what happened or what is wrong. The
autodoc-process-docstring should work according to the sphinx documentation.

Per A.

On 19 March 2015 at 17:52, Christoph Deil notifications@github.com wrote:

With Python 3.4 and Sphinx 1.3 I get the following error when I try to
build the numdifftools docs:

$ python setup.py build_sphinx
/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/setuptools/dist.py:291: UserWarning: The version specified ('unknown') is an invalid version, this may not work as expected with newer versions of setuptools, pip, and PyPI. Please see PEP 440 for more details.
"details." % self.metadata.version
running build_sphinx
Running Sphinx v1.3
Creating file /Users/deil/code/numdifftools/docs/../docs/_rst/numdifftools.rst.
Creating file /Users/deil/code/numdifftools/docs/../docs/_rst/numdifftools.tests.rst.
Creating file /Users/deil/code/numdifftools/docs/../docs/_rst/modules.rst.
Traceback (most recent call last):
File "setup.py", line 229, in
setup_package()
File "setup.py", line 226, in setup_package
entry_points={'console_scripts': CONSOLE_SCRIPTS})
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/core.py", line 148, in setup
dist.run_commands()
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/dist.py", line 955, in run_commands
self.run_command(cmd)
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/dist.py", line 974, in run_command
cmd_obj.run()
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/setup_command.py", line 161, in run
freshenv=self.fresh_env)
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/application.py", line 143, in init
self.setup_extension(extension)
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/application.py", line 440, in setup_extension
ext_meta = mod.setup(self)
File "/Users/deil/Library/Python/3.4/lib/python/site-packages/numpydoc/numpydoc.py", line 114, in setup
app.connect('autodoc-process-docstring', mangle_docstrings)
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/application.py", line 471, in connect
self._validate_event(event)
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/application.py", line 468, in _validate_event
raise ExtensionError('Unknown event name: %s' % event)
sphinx.errors.ExtensionError: Unknown event name: autodoc-process-docstring

cc @maniteja https://github.com/maniteja

—
Reply to this email directly or view it on GitHub
#2.

[cdeil]

With Google I found the tip that the numpydoc Sphinx extension should be listed at the end.
Attached find a commit that does this.

There's still a ton of Sphinx warnings about missing references:

...
None:None: WARNING: toctree contains reference to nonexisting document '_rst/numdifftools.core.Derivative.finaldelta'
None:None: WARNING: toctree contains reference to nonexisting document '_rst/numdifftools.core.Derivative.__call__'
None:None: WARNING: toctree contains reference to nonexisting document '_rst/numdifftools.core.Derivative.derivative'
None:None: WARNING: toctree contains reference to nonexisting document '_rst/numdifftools.core.Jacobian.delta'
None:None: WARNING: toctree contains reference to nonexisting document '_rst/numdifftools.core.Jacobian.finaldelta'
...

But at lest the Sphinx build puts out html docs now ...

[cdeil]

@pbrod – I currently don't have time to fix the Sphinx warnings. OK to merge this as-is and leave other work to future pull requests? Let me know if there' something you want me to change here.

[pbrod]

Thanks @cdeil