Review: Building/config related docs


"dbr/Ben" <b...@...>
 

Added Python versions of most of the C++ usage examples (except the GPU one, as the Processor.getGpuLut3D method isn't exposed). Might not be terribly practical code, but it's a nice demo of the Python bindings (plus not being hugely familiar with C++, I find it extremely useful seeing both side by side!)



Other commits relate the docs, mainly the setup page:

Link to license page from FAQ

"Building from source" page. Not totally sure this is best-practices etc, but seem sensible and looks similar to the existing INSTALL file

Mention the LD_ and DYLD_LIBRARY_PATH env-vars on setup page

"Nuke configuration" section on setup page

...and reorganise the headings for the above changes, to keep the ToC tidy (rST's heading notation is slightly.. odd)

Temporarily copied a built version of the updated docs to http://dl.dropbox.com/u/796113/ocio_docs_temp/index.html

Shall do the CLA tomorrow afternoon!
- Ben


Malcolm Humphreys <malcolmh...@...>
 

rock and roll these docs are great.

The only thing I can see is missing is a section on NUKE_PATH in the environment section.

.malcolm


On 14/01/2011, at 1:11 AM, dbr/Ben wrote:

Added Python versions of most of the C++ usage examples (except the GPU one, as the Processor.getGpuLut3D method isn't exposed). Might not be terribly practical code, but it's a nice demo of the Python bindings (plus not being hugely familiar with C++, I find it extremely useful seeing both side by side!)



Other commits relate the docs, mainly the setup page:

Link to license page from FAQ

"Building from source" page. Not totally sure this is best-practices etc, but seem sensible and looks similar to the existing INSTALL file

Mention the LD_ and DYLD_LIBRARY_PATH env-vars on setup page

"Nuke configuration" section on setup page

...and reorganise the headings for the above changes, to keep the ToC tidy (rST's heading notation is slightly.. odd)

Temporarily copied a built version of the updated docs to http://dl.dropbox.com/u/796113/ocio_docs_temp/index.html

Shall do the CLA tomorrow afternoon!
- Ben


"dbr/Ben" <b...@...>
 

On 14/01/2011, at 7:23 AM, Malcolm Humphreys wrote:

The only thing I can see is missing is a section on NUKE_PATH in the environment section.

Oh, good point - I forgot PYTHONPATH also. Mentioned both of these, and few other minor changes:


Also a slightly-unrelated change, but for some reason when building on OS X, Boost was not optional, as Boost_INCLUDE_DIR was used in core, pyglue and testbed. Not entirely sure this is the right solution, but it works for me..



On 14/01/2011, at 4:41 AM, Jeremy Selan wrote:

Oh, and an observation:  we now essentially have two masters for the
docs, the inline documentation, and the webpage version.  My
inclination is to treat the git version as the master, and then to do
periodic html / pdf drops to the website.    I'm thinking I could make
docs and post them for every dot release. Thoughts?

Do you mean having the http://opencolorio.org site be generated from the latest version's Sphinx docs? Or the sphinx docs be accessible from the site's "Documentation" link?

I think the former could be sensible - keep all the documentation in the git repository, so it is always in sync with the code, and make is simple to get the docs as they were for a given version

Should be pretty simple to tweak Sphinx so it works nicely as a homepage (with a nice intro page instead of just the table-of-contents and so on)

- Ben


Malcolm Humphreys <malcolmh...@...>
 


Oh, good point - I forgot PYTHONPATH also. Mentioned both of these, and few other minor changes:


LGTM

Also a slightly-unrelated change, but for some reason when building on OS X, Boost was not optional, as Boost_INCLUDE_DIR was used in core, pyglue and testbed. Not entirely sure this is the right solution, but it works for me..


LGTM

This is a good fix till we add boost/shared_ptr.hpp to ocio or replace it with tr1/memory in OpenColorTypes.h. Right now you need boost on linux to build.

.malcolm

I think the former could be sensible - keep all the documentation in the git repository, so it is always in sync with the code, and make is simple to get the docs as they were for a given version

+1

.malcolm


Jeremy Selan <jeremy...@...>
 

Committed.

Thanks!

-- Jeremy

On Sun, Jan 16, 2011 at 4:38 PM, Malcolm Humphreys
<malcolmh...@mac.com> wrote:

Oh, good point - I forgot PYTHONPATH also. Mentioned both of these, and few
other minor changes:
https://github.com/dbr/OpenColorIO/commit/573356952ca30f90b3cb4aafa925b33cbf974f99

LGTM