Local Sphinx Docs Build Pyhton 3.4 Sphinx 1.3.5 Problem

[Neil Tiffin]

I can’t seem to force the docs to build. The command according to commit cc00b88 is ‘sphinx-autobuild . _build_html’, but python 3.4 sphinx installed from macports only installs the following:

/opt/local/bin/sphinx-apidoc
/opt/local/bin/sphinx-autogen
/opt/local/bin/sphinx-build
/opt/local/bin/sphinx-quickstart

It would be helpful to know what version of python and Sphinx we should expect to work?

——————————————————————
Trying ‘sphinx-autogen . _build_html’ gives:
——————————————————————
MBP:docs nt$ sphinx-autogen . _build_html
[autosummary] generating autosummary for: ., _build_html
Traceback (most recent call last):
File "/opt/local/bin/sphinx-autogen", line 9, in <module>
load_entry_point('Sphinx==1.3.5', 'console_scripts', 'sphinx-autogen')()
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/ext/autosummary/generate.py", line 72, in main
template_dir=options.templates)
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/ext/autosummary/generate.py", line 115, in generate_autosummary_docs
items = find_autosummary_in_files(sources)
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/site-packages/sphinx/ext/autosummary/generate.py", line 225, in find_autosummary_in_files
errors='ignore') as f:
File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/codecs.py", line 891, in open
file = builtins.open(filename, mode, buffering)
IsADirectoryError: [Errno 21] Is a directory: '.'

——————————————————————
Trying ‘sphinx-build . _build_html' gives:
——————————————————————
MBP:docs nt$ sphinx-build . _build_html
Running Sphinx v1.3.5
making output directory...

Exception occurred:
File "conf.py", line 295, in <module>
from recommonmark.parser import CommonMarkParser
ImportError: No module named 'recommonmark'
The full traceback has been saved in /var/folders/tj/whjnklw94_x_79g2_4znlpxc0000gn/T/sphinx-err-v7p0ffsm.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

——————————————————————
Trying ‘make html’ gives:
——————————————————————
sphinx-build -b html -d _build/doctrees . _build/html
Running Sphinx v1.3.5
making output directory...

Exception occurred:
File "conf.py", line 295, in <module>
from recommonmark.parser import CommonMarkParser
ImportError: No module named 'recommonmark'
The full traceback has been saved in /var/folders/tj/whjnklw94_x_79g2_4znlpxc0000gn/T/sphinx-err-qb5dzl02.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!


Thank,
Neil

[Ben Swift]

Hi Neil

The sphinx doc stuff is really very experimental at this stage - so
there will be issues with it. Still, I've included a couple more
instructions at the top of conf.py, so give that a try.

Cheers,
Ben

[Neil Tiffin]

Ben,

I was using the most recent comment from 3 days ago and the instructions in docs/index.rst that don’t seem to work. I did not really find any helpful instructions at the top of conf.py. I’ll just wait till they are a little more mature.

Thanks,

Neil

> --
> You received this message because you are subscribed to the Google Groups "Extempore" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to extemporelan...@googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

[Ben Swift]

Yep, I'd say that's probably the way to go at the moment. Although I
just realised I hadn't pushed up the extra instructions I mentioned -
have just done so. Sorry about that.

[Neil Tiffin]

Ben,

Actually that did help.

For anyone searching the archives, MacPorts sphinx install does not install everything needed. So you need to install sphinx-autobuild and recommonmark from pip

Then the pip stuff was not by default in my path, so the command that worked for me was:

/opt/local/Library/Frameworks/Python.framework/Versions/3.4/bin/sphinx-autobuild . _build_html

Thanks,

Neil