build instructions for the docs don't work

[pigeonflight]

The build instructions in the README.rst file don't work on a freshly checked out copy of the docs. It assumes that the 'bootstrap.py' file is in the papyrus folder but it isn't there.

[svx]

I can not reproduce that, it is working fine here:

• git clone https://github.com/plone/papyrus.git
• cd papyrus/
• python bootstrap.py
• ./bin/buildout -vvv

You don't have to checkout the docs, you just checkout papyrus, the doc repo is just the source rst files are the building is done via papurus

[pigeonflight]

Okay... I realize that I misread the instructions.

On Ubuntu 12.04 I had to do the following in the papyrus directory

bin/pip install --upgrade setuptools

Then the python bootstrap.py worked.

If I neglect the upgrade step I get the following error:

pkg_resources.DistributionNotFound: setuptools>=0.7    

[djay]

Normally these days I find most reliable instructions for buildout are Virtualenv . Bin/pip install --upgrade setuptools Bin/python bootstrap.py

Of course you have to ensure your buildout doesn't install bin/python :) On 15 Sep 2014 08:03, "David Bain" notifications@github.com wrote:

Okay... I realize that I misread the instructions.

On Ubuntu 12.04 I had to do the following in the papyrus directory

bin/pip install --upgrade setuptools

Then the python bootstrap.py worked.

If I neglect the upgrade step I get the following error:

pkg_resources.DistributionNotFound: setuptools>=0.7

— Reply to this email directly or view it on GitHub https://github.com/plone/documentation/issues/122#issuecomment-55541080.

[pigeonflight]

I think it's worth updating the instructions. I'm also thinking there might be a way to use a "unified installer" based variation of the install, which would get things installed more quickly.

[polyester]

Note that installing this on your own computer is not exactly the recommended way; of course the instructions should work, but for offline reading of the docs I'd advise something like Zeal or Dash.

Especially if you want to generate PDF, you need just about everything & the kitchensink. (think latex-full packages, they are huge). So the instructions here are for the build-machine, and your laptop if you're dedicated or want to help improve the process, but not recommended for end users of the documentation.

it might be better to have the README not contain instructions on building, but instead pointing to https://github.com/plone/papyrus which is where they should be, with a hint that this is not the recommended way.

[svx]

There is also more, I already asked that on irc, but not 'in the public' yet, we are testing docker images atthemoment, so you just can pull th eimage from docker and run it and you have the docs, we have also already a working vargant image, which is building fast and working fine... But as Paul said, you don'want to do that normaly, the best way to browse the docs local, is zeal/dash or on the webiste. I do not see the point of creating a 'UI for the docs' what would be the 'big win' of doing that ? If you really want the full stack local use the docler image, the vagrant box or build papyrus :)

[svx]

see: https://community.plone.org/t/documentation-images-vms-container/289