Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor doc errors #246

Closed
dbr opened this issue Mar 27, 2012 · 4 comments
Closed

Minor doc errors #246

dbr opened this issue Mar 27, 2012 · 4 comments
Labels
Documentation Documentation related development and/or updates.

Comments

@dbr
Copy link
Contributor

dbr commented Mar 27, 2012

Few minor errors in the docs:

http://opencolorio.org/installation.html#quick-environment-configuration has wrong title in link, "For prebuilt config files, see the Contributor License Agreements download section"

http://opencolorio.org/developers/bindings/PythonAPI.html#PyOpenColorIO.Config.getCacheID A few of the Python API docs have incorrect :py:method links

@jeremyselan
Copy link
Contributor

Committed a4ebb83, which fixes the docs source files.

However, when I build the python docs I'm still not seeing the proper signatures in the generated xml. @malcolmhumphreys - Do you know why this is?

For example, if you check out
https://github.com/imageworks/OpenColorIO/blob/master/src/pyglue/DocStrings/Processor.py#L40
you will see an arg is defined.

However, in the website version this function has no args:
http://opencolorio.org/developers/bindings/PythonAPI.html#PyOpenColorIO.Config.getProcessor

How are these signatures generated?

When I import DocStrings in python, and do help(DocStrings.Processor) I do see the right signature.

@malcolmhumphreys
Copy link
Contributor

Yeah sorry should have mentioned we need to upgrade our sphinx version, i have part of this work already done. Just a tad busy at work this week.

@jeremyselan
Copy link
Contributor

No worries, good to know. thanks

@scoopxyz scoopxyz added the Documentation Documentation related development and/or updates. label Jan 25, 2017
@scoopxyz
Copy link
Contributor

Closed by 2b12063

fnordware pushed a commit to fnordware/OpenColorIO that referenced this issue Oct 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related development and/or updates.
Projects
None yet
Development

No branches or pull requests

4 participants