sdouche / collective.recipe.sphinxbuilder Goto Github PK

If you use c.r.s in version 0.7.1, your buildout pulls Sphinx 1.0.8. When you run bin/sphinxbuilder (make html or make latex or ...) there is an error:

...
File "/home/pab/.buildout/eggs/Sphinx-1.0.8-py2.7.egg/sphinx/roles.py", line 129, in call
set_role_source_info(inliner, lineno, refnode)
File "/home/pab/.buildout/eggs/Sphinx-1.0.8-py2.7.egg/sphinx/util/nodes.py", line 114, in set_role_source_info
inliner.reporter.locator(lineno)
AttributeError: Reporter instance has no attribute 'locator'

But if you pin Sphinx >= 1.1, no error will appear.

This could be done by requirements of collective.recipe.sphinxbuilder.

When I run this receipt I got the following exception

  File "c:\projects\xxxx\buildout\eggs\collective.recipe.sphinxbuilder-0.7.3-py2.7.egg\collective\recipe\sphinxbuilder\__init__.py", line 153, in install
    sb_file = open(sb,'r')
IOError: [Errno 2] No such file or directory: 'C:\\projects\\xxxx\\bin\\sphinx-build'

The problem is in the following code:

        sb = os.path.join(self.bin_dir, 'sphinx-build')

The generated script has name sphinx-build-script.py on windows system.

if this package belongs to the plone collective please move it to collective so that other could contribute more easy and the packe might be more maintained.

This recipe is failing with a pretty standard setup.py-reads-the-readme unicode error:

  File "/tmp/easy_install-9hksyjve/collective.recipe.sphinxbuilder-0.8.2/setup.py", line 9, in read
    ])
  File "/usr/lib/python3.5/encodings/ascii.py", line 26, in decode
    return codecs.ascii_decode(input, self.errors)[0]
UnicodeDecodeError: 'ascii' codec can't decode byte 0xc3 in position 180: ordinal not in range(128)
An error occurred when trying to install collective.recipe.sphinxbuilder 0.8.2. Look above this message     for any errors that were output by easy_install.

I can probably fix that quite soon, but.... is this project still alive? Will there be a new release if needed?

A windows-using colleague has its buildout in c:\3di\something. The self.re_sphinxbuild.sub() replacement code gives an invalid group reference regex exception.

The reason is that the \3 is treated as "give me the 3th matched item" by the regex code.

Renaming the directory to start with something else than a character solves it.

So.. this is pretty much a corner case. I don't know how easy it is to fix it. I've looked at regex flags, but couldn't find one to switch off the backslash handling. Perhaps a \ => \\ on the path that buildout gives?

OTOH, just noting it in the documentation could be enough, too :-)

Then people can contribute more easily.

http://collective.github.com/

Documentation link (http:/docs.garbas.si/collective.recipe.sphinxbuilder) is broken.

Perhaps just link to PyPI (https://pypi.python.org/pypi/collective.recipe.sphinxbuilder)? It does contain useful information.

Occurs when running bin/buildout.

The part:

[sphinxbuilder_connector]
recipe = collective.recipe.sphinxbuilder
source = ${buildout:directory}/parts/connector/connector/doc
build = docs
interpreter = ${buildout:directory}/bin/python_openerp

Traceback:

collective.recipe.sphinxbuilder: writing MAKEFILE..
collective.recipe.sphinxbuilder: writing BATCHFILE..
collective.recipe.sphinxbuilder: writing custom sphinx-builder script..
While:
  Updating sphinxbuilder_connector.

An internal error occurred due to a bug in either zc.buildout or in a
recipe being used:
Traceback (most recent call last):
  File "/home/gbaconnier/.buildout/eggs/zc.buildout-2.2.1-py2.7.egg/zc/buildout/buildout.py", line 1942, in main
    getattr(buildout, command)(args)
  File "/home/gbaconnier/.buildout/eggs/zc.buildout-2.2.1-py2.7.egg/zc/buildout/buildout.py", line 592, in install
    installed_files = self[part]._call(update)
  File "/home/gbaconnier/.buildout/eggs/zc.buildout-2.2.1-py2.7.egg/zc/buildout/buildout.py", line 1366, in _call
    return f()
  File "/home/gbaconnier/.buildout/eggs/collective.recipe.sphinxbuilder-0.8.2-py2.7.egg/collective/recipe/sphinxbuilder/__init__.py", line 141, in install
    self.bin_dir, **egg_options)
  File "/home/gbaconnier/.buildout/eggs/zc.buildout-2.2.1-py2.7.egg/zc/buildout/easy_install.py", line 931, in scripts
    assert executable == sys.executable, (executable, sys.executable)
AssertionError: ('/usr/bin/python', '/home/gbaconnier/projects/openerp/sandbox/bin/python')

Reason is that this line: https://github.com/sdouche/collective.recipe.sphinxbuilder/blob/master/src/collective/recipe/sphinxbuilder/__init__.py#L140 pass /usr/bin/python to zc.buildout.easy_install.scripts whereas it expects the virtualenv's one. I don't know much the buildout internals, but it seems that anyway this parameter is not used. Using sys.executable instead of self.buildout[self.buildout['buildout']['python']]['executable'] seems better.

Hi,

The build directory is usually 'docs'. However, I have a buildout which may have many documentations (1 documentation per OpenERP addons), so I need a build directory as follows (each documentation has its own buildsphinx command line):

docs/addons1
docs/addons2
...

Actually, we can't use sub-directories in the build option.

This is because the build directories are created using os.mkdir, I propose to use os.makedirs (I'm doing a PR).

please make a new variable which will set makefile_path and batchfile_path.

creating them in the build_dir make no sense, as a make clean will delete it.