Skip to content

initial v2 doc restructure #1075

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

Conversation

scoopxyz
Copy link
Contributor

Signed-off-by: Sean Cooper [email protected]

scoopxyz added 2 commits July 24, 2020 02:11
Signed-off-by: Sean Cooper <[email protected]>
Copy link
Collaborator

@doug-walker doug-walker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Sean, this is super helpful!

I notice that you are deleting the image files used for the baking_luts.rst and spi_vfx.rst pages. I was going to keep both of those pages and so we should keep the images too. Perhaps move them under the tutorials directory for now please (unless I'm misunderstanding what you've done).

Thanks!!

@doug-walker doug-walker added Documentation Documentation related development and/or updates. v2.0 labels Jul 24, 2020
scoopxyz added 2 commits July 24, 2020 10:29
Signed-off-by: Sean Cooper <[email protected]>
@scoopxyz
Copy link
Contributor Author

The CI is now failing because of its required Python dependencies. @michdolan how do we manage Python dependencies for the CI?

Signed-off-by: Sean Cooper <[email protected]>
@scoopxyz
Copy link
Contributor Author

Thanks Sean, this is super helpful!

I notice that you are deleting the image files used for the baking_luts.rst and spi_vfx.rst pages. I was going to keep both of those pages and so we should keep the images too. Perhaps move them under the tutorials directory for now please (unless I'm misunderstanding what you've done).

Thanks!!

added back

@michdolan
Copy link
Collaborator

See my explanation in #1074 on installing Python packages via CMake.

scoopxyz added 10 commits July 27, 2020 22:55
Signed-off-by: Sean Cooper <[email protected]>
Signed-off-by: Sean Cooper <[email protected]>
Signed-off-by: Sean Cooper <[email protected]>
Signed-off-by: Sean Cooper <[email protected]>
Signed-off-by: Sean Cooper <[email protected]>
Signed-off-by: Sean Cooper <[email protected]>
modify python macro to support dependencies

Signed-off-by: Sean Cooper <[email protected]>
@scoopxyz
Copy link
Contributor Author

Now running into errors, where a lot of python packages don't like have a manual prefix specified by the python macro...

Will need to dig into what's required to work around that

Installing collected packages: sphinxcontrib-applehelp, sphinxcontrib-devhelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, MarkupSafe, Jinja2, Pygments, docutils, snowballstemmer, pytz, babel, alabaster, imagesize, chardet, idna, urllib3, certifi, requests, setuptools, pyparsing, six, packaging, sphinx, sphinxemoji, romnnn-sphinx-press-theme
    Running setup.py install for sphinxcontrib-applehelp ... error
    ERROR: Command errored out with exit status 1:
     command: /usr/bin/python -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-20f8ufsi/sphinxcontrib-applehelp/setup.py'"'"'; __file__='"'"'/tmp/pip-install-20f8ufsi/sphinxcontrib-applehelp/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' install --record /tmp/pip-record-lhpzn1vh/install-record.txt --single-version-externally-managed --user --prefix= --compile --install-headers /home/fawlty/.local/include/python3.8/sphinxcontrib-applehelp --prefix=/media/fawlty/Alpha/Dev/github/OpenColorIO/build/ext/dist
         cwd: /tmp/pip-install-20f8ufsi/sphinxcontrib-applehelp/
    Complete output (2 lines):
    running install
    error: can't combine user with prefix, exec_prefix/home, or install_(plat)base
    ----------------------------------------
ERROR: Command errored out with exit status 1: /usr/bin/python -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-20f8ufsi/sphinxcontrib-applehelp/setup.py'"'"'; __file__='"'"'/tmp/pip-install-20f8ufsi/sphinxcontrib-applehelp/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' install --record /tmp/pip-record-lhpzn1vh/install-record.txt --single-version-externally-managed --user --prefix= --compile --install-headers /home/fawlty/.local/include/python3.8/sphinxcontrib-applehelp --prefix=/media/fawlty/Alpha/Dev/github/OpenColorIO/build/ext/dist Check the logs for full command output.
make[2]: *** [CMakeFiles/romnnn-sphinx-press-theme.dir/build.make:57: romnnn-sphinx-press-theme] Error 1
make[1]: *** [CMakeFiles/Makefile2:804: CMakeFiles/romnnn-sphinx-press-theme.dir/all] Error 2
make: *** [Makefile:141: all] Error 2

@scoopxyz
Copy link
Contributor Author

pypa/pip#7309

scoopxyz added 2 commits July 29, 2020 09:13
Signed-off-by: Sean Cooper <[email protected]>
Signed-off-by: Sean Cooper <[email protected]>
@scoopxyz
Copy link
Contributor Author

scoopxyz commented Jul 29, 2020

Latest is Windows builds failing:

Could not import extension recommonmark (exception: No module named 'recommonmark')

Leads me to believe we're not populating the windows PYTHONPATH correctly through the docs CMakeLists.txt

@scoopxyz
Copy link
Contributor Author

Well... I ended up cheating a bit. Blocking doc generation for Python 2 and Windows. I'm not sure that we'll ever be able to support Python 2, but we can certainly get Windows working in the future, I just don't have a local Windows machine so it's hell to test via CI.
Waiting for second approval then we can merge and focus on getting it working with RTD. Plus I need to add back in sphinx-tabs as I was also having cross-platform build issues with that....

@doug-walker doug-walker merged commit 3757d95 into AcademySoftwareFoundation:master Jul 31, 2020
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

Successfully merging this pull request may close these issues.

3 participants