[Bf-docboard] security considerations about building the new blender manual ...

Gaia gaia.clary at machinimatrix.org
Thu Sep 25 12:32:53 CEST 2014


Troubled has pointed out in #blendercoders that running "make"
on the new sphinx based document system is potentially
dangerous and could even damage the documentor's computer.
While the chance seems small that this really happens, it still
seems to be one of the reasons why we do not yet get an
automated documentation build system.

I think that all documentors should be made aware
of this problem here:

     https://developer.blender.org/project/view/53/

I believe that adding a remark about security and how to
generate the documentation on a local computer more
securely is important.

Troubled mentioned the following alternative to make would
be a safe way to build the docs:

     sphinx-build -b html ./manual ./html

The above mentioned document proposes to use the evil
make instead ...

cheers,
Gaia


More information about the Bf-docboard mailing list