Review: Building/config related docs


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

Looks good to me.
These commits were all on the same topic, so I merged them into a
single checkin, "Documentation cleanup".

Thanks!

-- Jeremy

On Thu, Jan 13, 2011 at 6:11 AM, dbr/Ben <b...@neverfear.org> 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!)
https://github.com/dbr/OpenColorIO/commit/5e7c9e16519356e738261c690ad2932b8dea910f

Other commits relate the docs, mainly the setup page:
Link to license page from FAQ
https://github.com/dbr/OpenColorIO/commit/b84e3b4ac3fb2705c04e9004333474ae0d047d28
"Building from source" page. Not totally sure this is best-practices etc,
but seem sensible and looks similar to the existing INSTALL file
https://github.com/dbr/OpenColorIO/commit/c989ad2b3f560b20c54ef511752ca222aec522af
Mention the LD_ and DYLD_LIBRARY_PATH env-vars on setup page
https://github.com/dbr/OpenColorIO/commit/ff7a47595ddb2919f0fcdf7d9d66094087a340b0
"Nuke configuration" section on setup page
https://github.com/dbr/OpenColorIO/commit/0e8bbb922136d58271866dee82b747148244db70
...and reorganise the headings for the above changes, to keep the ToC tidy
(rST's heading notation is slightly.. odd)
https://github.com/dbr/OpenColorIO/commit/ed47a03cb2b47ef86b25a60ecad8370c54810a5d
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


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

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?

-- Jeremy

On Thu, Jan 13, 2011 at 10:08 AM, Jeremy Selan <jeremy...@gmail.com> wrote:
Looks good to me.
These commits were all on the same topic, so I merged them into a
single checkin, "Documentation cleanup".

Thanks!

-- Jeremy

On Thu, Jan 13, 2011 at 6:11 AM, dbr/Ben <b...@neverfear.org> 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!)
https://github.com/dbr/OpenColorIO/commit/5e7c9e16519356e738261c690ad2932b8dea910f

Other commits relate the docs, mainly the setup page:
Link to license page from FAQ
https://github.com/dbr/OpenColorIO/commit/b84e3b4ac3fb2705c04e9004333474ae0d047d28
"Building from source" page. Not totally sure this is best-practices etc,
but seem sensible and looks similar to the existing INSTALL file
https://github.com/dbr/OpenColorIO/commit/c989ad2b3f560b20c54ef511752ca222aec522af
Mention the LD_ and DYLD_LIBRARY_PATH env-vars on setup page
https://github.com/dbr/OpenColorIO/commit/ff7a47595ddb2919f0fcdf7d9d66094087a340b0
"Nuke configuration" section on setup page
https://github.com/dbr/OpenColorIO/commit/0e8bbb922136d58271866dee82b747148244db70
...and reorganise the headings for the above changes, to keep the ToC tidy
(rST's heading notation is slightly.. odd)
https://github.com/dbr/OpenColorIO/commit/ed47a03cb2b47ef86b25a60ecad8370c54810a5d
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


Joseph Slomka <jsl...@...>
 

This makes sense as you get to release. The code gets the most frequent updates and the webpage represents the current used version.

-----Original Message-----
From: ocio...@googlegroups.com [mailto:ocio...@googlegroups.com] On Behalf Of Jeremy Selan
Sent: Thursday, January 13, 2011 10:11 AM
To: ocio...@googlegroups.com
Subject: Re: [ocio-dev] Review: Building/config related docs

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?

-- Jeremy

On Thu, Jan 13, 2011 at 10:08 AM, Jeremy Selan <jeremy...@gmail.com> wrote:
Looks good to me.
These commits were all on the same topic, so I merged them into a
single checkin, "Documentation cleanup".

Thanks!

-- Jeremy

On Thu, Jan 13, 2011 at 6:11 AM, dbr/Ben <b...@neverfear.org> 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!)
https://github.com/dbr/OpenColorIO/commit/5e7c9e16519356e738261c690ad2932b8dea910f

Other commits relate the docs, mainly the setup page:
Link to license page from FAQ
https://github.com/dbr/OpenColorIO/commit/b84e3b4ac3fb2705c04e9004333474ae0d047d28
"Building from source" page. Not totally sure this is best-practices etc,
but seem sensible and looks similar to the existing INSTALL file
https://github.com/dbr/OpenColorIO/commit/c989ad2b3f560b20c54ef511752ca222aec522af
Mention the LD_ and DYLD_LIBRARY_PATH env-vars on setup page
https://github.com/dbr/OpenColorIO/commit/ff7a47595ddb2919f0fcdf7d9d66094087a340b0
"Nuke configuration" section on setup page
https://github.com/dbr/OpenColorIO/commit/0e8bbb922136d58271866dee82b747148244db70
...and reorganise the headings for the above changes, to keep the ToC tidy
(rST's heading notation is slightly.. odd)
https://github.com/dbr/OpenColorIO/commit/ed47a03cb2b47ef86b25a60ecad8370c54810a5d
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