diff --git a/docs/.nojekyll b/.nojekyll similarity index 100% rename from docs/.nojekyll rename to .nojekyll diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 8557e0423d..cdcd05d122 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -4,172 +4,188 @@ ############################################################################### ### Python ### find_package(Python REQUIRED COMPONENTS Interpreter) -if(NOT OCIO_BUILD_PYTHON) - message(FATAL_ERROR "Doc generation requires that the python bindings be built") -endif() +if((${Python_VERSION_MAJOR} GREATER_EQUAL 3) AND (NOT WIN32)) + if(NOT OCIO_BUILD_PYTHON) + message(FATAL_ERROR "Doc generation requires that the python bindings be built") + endif() -############################################################################### -### Setup PYTHONPATH ### - -# Override PYTHONPATH prior to running Sphinx. This makes the PyOpenColorIO -# build available, prioritizes ext/ installed Python dependencies, and -# propagates the system PYTHONPATH. -if(WIN32) - # Use Windows path separators since this is being passed through to cmd - file(TO_NATIVE_PATH ${CMAKE_BINARY_DIR} WIN_BINARY_DIR) - - set(DLL_PATH "${WIN_BINARY_DIR}\\src\\OpenColorIO") - if(MSVC_IDE) - set(DLL_PATH "${DLL_PATH}\\${CMAKE_BUILD_TYPE}") + ############################################################################### + ### Setup PYTHONPATH ### + + # Override PYTHONPATH prior to running Sphinx. This makes the PyOpenColorIO + # build available, prioritizes ext/ installed Python dependencies, and + # propagates the system PYTHONPATH. + if(WIN32) + # Use Windows path separators since this is being passed through to cmd + file(TO_NATIVE_PATH ${CMAKE_BINARY_DIR} WIN_BINARY_DIR) + + set(DLL_PATH "${WIN_BINARY_DIR}\\src\\OpenColorIO") + if(MSVC_IDE) + set(DLL_PATH "${DLL_PATH}\\${CMAKE_BUILD_TYPE}") + endif() + + string(CONCAT PATH_SET + "PATH=" + "${DLL_PATH}" + "\\\\;" + "%PATH%" + ) + + set(PYD_PATH "${WIN_BINARY_DIR}\\src\\bindings\\python") + if(MSVC_IDE) + set(PYD_PATH "${PYD_PATH}\\${CMAKE_BUILD_TYPE}") + endif() + + string(CONCAT PYTHONPATH_SET + "PYTHONPATH=" + "${PYD_PATH}" + "\\\\;" + "${WIN_BINARY_DIR}\\ext\\dist\\lib${LIB_SUFFIX}\\site-packages" + "\\\\;" + "%PYTHONPATH%" + ) + # Mimic *nix: + # '> PYTHONPATH=XXX CMD' + # on Windows with: + # '> set PYTHONPATH=XXX \n call CMD' + # '\n' is here because '\\&' does not work. + set(PYT_PRE_CMD set ${PATH_SET} "\n" set ${PYTHONPATH_SET} "\n" call) + + else() + set(_Python_VARIANT "${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}") + string(CONCAT PYT_PRE_CMD + "PYTHONPATH=" + "${CMAKE_BINARY_DIR}/src/bindings/python" + ":" + "${CMAKE_BINARY_DIR}/ext/dist/lib${LIB_SUFFIX}/python${_Python_VARIANT}/site-packages" + ":" + "$ENV{PYTHONPATH}" + ) endif() - string(CONCAT PATH_SET - "PATH=" - "${DLL_PATH}" - "\\\\;" - "%PATH%" - ) + ############################################################################### + ### Copy templates to build area ### - set(PYD_PATH "${WIN_BINARY_DIR}\\src\\bindings\\python") - if(MSVC_IDE) - set(PYD_PATH "${PYD_PATH}\\${CMAKE_BUILD_TYPE}") + file(GLOB_RECURSE DOC_SOURCES "${CMAKE_SOURCE_DIR}/docs/*") + list(APPEND DOC_SOURCES + ${CMAKE_SOURCE_DIR}/README.md + ${CMAKE_SOURCE_DIR}/INSTALL.md + ${CMAKE_SOURCE_DIR}/CHANGELOG.md + ${CMAKE_SOURCE_DIR}/LICENSE + ) + if(OCIO_BUILD_NUKE) + list(APPEND DOC_SOURCES ${CMAKE_SOURCE_DIR}/share/nuke/ocionuke/viewer.py) endif() - string(CONCAT PYTHONPATH_SET - "PYTHONPATH=" - "${PYD_PATH}" - "\\\\;" - "${WIN_BINARY_DIR}\\ext\\dist\\lib\\site-packages" - "\\\\;" - "%PYTHONPATH%" + add_custom_target(doc_copy + COMMENT "Copying doc files to staging area" ) - # Mimic *nix: - # '> PYTHONPATH=XXX CMD' - # on Windows with: - # '> set PYTHONPATH=XXX \n call CMD' - # '\n' is here because '\\&' does not work. - set(PYT_PRE_CMD set ${PATH_SET} "\n" set ${PYTHONPATH_SET} "\n" call) -else() - set(_Python_VARIANT "${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}") - string(CONCAT PYT_PRE_CMD - "PYTHONPATH=" - "${CMAKE_BINARY_DIR}/src/bindings/python" - ":" - "${CMAKE_BINARY_DIR}/ext/dist/lib${LIB_SUFFIX}/python${_Python_VARIANT}/site-packages" - ":" - "$ENV{PYTHONPATH}" + foreach(f ${DOC_SOURCES}) + string(REGEX REPLACE "^${CMAKE_SOURCE_DIR}/" "" relpath ${f}) + string(REGEX REPLACE "[/. ]" "_" tgtname ${relpath}) + string(REGEX MATCH "^docs" IN_DOCS ${relpath}) + + set(SRC_PATH ${CMAKE_SOURCE_DIR}/${relpath}) + set(DST_PATH ${CMAKE_BINARY_DIR}/${relpath}) + if(NOT IN_DOCS) + get_filename_component(F_NAME ${relpath} NAME) + set(DST_PATH "${CMAKE_BINARY_DIR}/docs/${F_NAME}") + endif() + + add_custom_command(OUTPUT ${DST_PATH} + COMMAND ${CMAKE_COMMAND} -E copy ${SRC_PATH} ${DST_PATH} + DEPENDS ${SRC_PATH} + ) + add_custom_target("copy_${tgtname}" DEPENDS ${DST_PATH}) + add_dependencies(doc_copy "copy_${tgtname}") + endforeach() + + ############################################################################### + ### Extract rst from c++ headers ### + + set(EXTRACT_COMMAND "${CMAKE_SOURCE_DIR}/share/sphinx/ExtractRstFromSourceCPP.py") + set(OCIO_HEADER_DIR "${CMAKE_SOURCE_DIR}/include/OpenColorIO") + set(RST_DESTINATION "${CMAKE_BINARY_DIR}/docs/developers/api/") + add_custom_target(rst_extraction + COMMAND ${CMAKE_COMMAND} -E make_directory ${RST_DESTINATION} + COMMAND ${Python_EXECUTABLE} ${EXTRACT_COMMAND} ${OCIO_HEADER_DIR}/OpenColorIO.h ${RST_DESTINATION}/OpenColorIO.rst + COMMAND ${Python_EXECUTABLE} ${EXTRACT_COMMAND} ${OCIO_HEADER_DIR}/OpenColorTransforms.h ${RST_DESTINATION}/OpenColorTransforms.rst + COMMAND ${Python_EXECUTABLE} ${EXTRACT_COMMAND} ${OCIO_HEADER_DIR}/OpenColorTypes.h ${RST_DESTINATION}/OpenColorTypes.rst + COMMENT "Extracting .rst files from C++ headers" ) -endif() - -############################################################################### -### Copy templates to build area ### - -message(STATUS "Create sphinx conf.py from conf.py.in") -configure_file(conf.py.in ${CMAKE_BINARY_DIR}/docs/conf.py @ONLY) - -file(GLOB_RECURSE DOC_SOURCES "${CMAKE_SOURCE_DIR}/docs/*") -list(APPEND DOC_SOURCES - ${CMAKE_SOURCE_DIR}/README.md - ${CMAKE_SOURCE_DIR}/INSTALL.md - ${CMAKE_SOURCE_DIR}/CHANGELOG.md - ${CMAKE_SOURCE_DIR}/LICENSE -) -if(OCIO_BUILD_NUKE) - list(APPEND DOC_SOURCES ${CMAKE_SOURCE_DIR}/share/nuke/ocionuke/viewer.py) -endif() - -add_custom_target(doc_copy - COMMENT "Copying doc files to staging area" -) -foreach(f ${DOC_SOURCES}) - string(REGEX REPLACE "^${CMAKE_SOURCE_DIR}/" "" relpath ${f}) - string(REGEX REPLACE "[/. ]" "_" tgtname ${relpath}) - string(REGEX MATCH "^docs" IN_DOCS ${relpath}) + ############################################################################### + ### HTML doc target ### - set(SRC_PATH ${CMAKE_SOURCE_DIR}/${relpath}) - set(DST_PATH ${CMAKE_BINARY_DIR}/${relpath}) - if(NOT IN_DOCS) - get_filename_component(F_NAME ${relpath} NAME) - set(DST_PATH "${CMAKE_BINARY_DIR}/docs/${F_NAME}") - endif() - - add_custom_command(OUTPUT ${DST_PATH} - COMMAND ${CMAKE_COMMAND} -E copy ${SRC_PATH} ${DST_PATH} - DEPENDS ${SRC_PATH} + add_custom_target(docs ALL + COMMAND + ${PYT_PRE_CMD} "${Sphinx_EXECUTABLE}" -b html . "${CMAKE_CURRENT_BINARY_DIR}/build-html" + DEPENDS + ${CMAKE_BINARY_DIR}/docs/conf.py + COMMENT "Building html docs" ) - add_custom_target("copy_${tgtname}" DEPENDS ${DST_PATH}) - add_dependencies(doc_copy "copy_${tgtname}") -endforeach() - -############################################################################### -### Extract rst from c++ headers ### - -set(EXTRACT_COMMAND "${CMAKE_SOURCE_DIR}/share/sphinx/ExtractRstFromSourceCPP.py") -set(OCIO_HEADER_DIR "${CMAKE_SOURCE_DIR}/include/OpenColorIO") -set(RST_DESTINATION "${CMAKE_BINARY_DIR}/docs/developers/api/") -add_custom_target(rst_extraction - COMMAND ${CMAKE_COMMAND} -E make_directory ${RST_DESTINATION} - COMMAND ${Python_EXECUTABLE} ${EXTRACT_COMMAND} ${OCIO_HEADER_DIR}/OpenColorIO.h ${RST_DESTINATION}/OpenColorIO.rst - COMMAND ${Python_EXECUTABLE} ${EXTRACT_COMMAND} ${OCIO_HEADER_DIR}/OpenColorTransforms.h ${RST_DESTINATION}/OpenColorTransforms.rst - COMMAND ${Python_EXECUTABLE} ${EXTRACT_COMMAND} ${OCIO_HEADER_DIR}/OpenColorTypes.h ${RST_DESTINATION}/OpenColorTypes.rst - COMMENT "Extracting .rst files from C++ headers" -) -############################################################################### -### HTML doc target ### - -add_custom_target(docs ALL - COMMAND - ${PYT_PRE_CMD} "${Sphinx_EXECUTABLE}" -b html . "${CMAKE_CURRENT_BINARY_DIR}/build-html" - DEPENDS + add_dependencies(docs OpenColorIO PyOpenColorIO - ${CMAKE_BINARY_DIR}/docs/conf.py rst_extraction doc_copy Sphinx - COMMENT "Building html docs" -) + sphinx-press-theme + recommonmark + ) -############################################################################### -### Installation ### + ############################################################################### + ### Installation ### -install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/build-html/ - DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/OpenColorIO/html - PATTERN .* EXCLUDE -) + install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/build-html/ + DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/OpenColorIO/html + PATTERN .* EXCLUDE + ) -############################################################################### -### PDF target ### + ############################################################################### + ### PDF target ### -find_package(LATEX) -package_root_message(LATEX) + find_package(LATEX) + package_root_message(LATEX) -if(PDFLATEX_COMPILER) + if(PDFLATEX_COMPILER) - add_custom_target(latex - COMMAND - ${PYT_PRE_CMD} "${Sphinx_EXECUTABLE}" -b latex . "${CMAKE_CURRENT_BINARY_DIR}/build-latex" - DEPENDS + add_custom_target(latex + COMMAND + ${PYT_PRE_CMD} "${Sphinx_EXECUTABLE}" -b latex . "${CMAKE_CURRENT_BINARY_DIR}/build-latex" + DEPENDS + ${CMAKE_BINARY_DIR}/docs/conf.py + COMMENT "Building latex doc" + ) + + add_dependencies(latex OpenColorIO PyOpenColorIO - ${CMAKE_BINARY_DIR}/docs/conf.py rst_extraction doc_copy Sphinx - COMMENT "Building latex doc" - ) + sphinx-press-theme + recommonmark + ) - add_custom_target(pdf ALL - DEPENDS latex - COMMAND ${PDFLATEX_COMPILER} OpenColorIO.tex - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/build-latex - COMMENT "Building pdf doc" - ) - install(FILES ${CMAKE_CURRENT_BINARY_DIR}/build-latex/OpenColorIO.pdf - DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/OpenColorIO/) + add_custom_target(pdf ALL + COMMAND ${PDFLATEX_COMPILER} OpenColorIO.tex + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/build-latex + COMMENT "Building pdf doc" + ) + + add_dependencies(pdf + latex + ) + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/build-latex/OpenColorIO.pdf + DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/OpenColorIO/) + + endif() + +else() + message(Warning "Skipping local documentation generation, requires Python >= 3.x") endif() diff --git a/docs/V2_DOC_README.md b/docs/V2_DOC_README.md new file mode 100644 index 0000000000..df31b41d82 --- /dev/null +++ b/docs/V2_DOC_README.md @@ -0,0 +1,47 @@ +# OCIO v2 Documentation Effort + +Since the API autodoc effort is happening simultaneously it will be easier for +a lot of contributors to do a light-weight build of the Sphinx docs, which +doesn't require building OCIO in its entirety. + +## How to Build RST-Only Docs + +In addition to the general OCIO v2 dependencies (Python and Sphinx), install the +Python packages listed in the `docs/requirements.txt` file. + +``` +pip install -r docs/requirements.txt +``` + +Build the sphinx docs locally... + +``` +cd docs +mkdir _build +sphinx-build -b html . _build +firefox _build/index.html +``` + + +## Quirks + +The vuepress theme that we've migrated to has some quirks to its design. For +example it only allows two nested table of contents (TOC). So things have to be +organized in a slightly different way than other sphinx projects. + +The root-level `toc_redirect.rst` points to where to find the different section +TOCs. The name and contents of each sections TOC is defined in that +sub-directory's `_index.rst` file. + +In this TOC the `:caption:` directive determines what the name of the section +will be in the side-bar, and in the header of the website. The *H1* header +determines the name of the page in the right/left arrows navigation bar. In a +lot of cases this ends up doubling up the name on the page, but this seems +unavoidable at the present time. If additional explanatory text is put in the +`_index.rst` files then it shouldn't be as problematic. + +The site will show all *H1* headers in the side panel by default, these then +expand when selected to show all *H2* headers. + +Due to the limited TOC and side-bar depth, we shouldn't be afraid of looong +pages with many *H2* headings to break down the page into logical quadrants. \ No newline at end of file diff --git a/docs/_static/OpenColorIO_withText.svg b/docs/_static/OpenColorIO_withText.svg new file mode 100644 index 0000000000..976f6dbc17 --- /dev/null +++ b/docs/_static/OpenColorIO_withText.svg @@ -0,0 +1 @@ +OpenColorIO logo \ No newline at end of file diff --git a/docs/api/_index.rst b/docs/api/_index.rst new file mode 100644 index 0000000000..dc94bd7060 --- /dev/null +++ b/docs/api/_index.rst @@ -0,0 +1,14 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +API +=== + +.. toctree:: + :caption: API + + installation + bindings/PythonAPI + bindings/PythonTransforms + bindings/PythonTypes \ No newline at end of file diff --git a/docs/developers/bindings/PythonAPI.rst b/docs/api/bindings/PythonAPI.rst similarity index 100% rename from docs/developers/bindings/PythonAPI.rst rename to docs/api/bindings/PythonAPI.rst diff --git a/docs/developers/bindings/PythonTransforms.rst b/docs/api/bindings/PythonTransforms.rst similarity index 100% rename from docs/developers/bindings/PythonTransforms.rst rename to docs/api/bindings/PythonTransforms.rst diff --git a/docs/developers/bindings/PythonTypes.rst b/docs/api/bindings/PythonTypes.rst similarity index 100% rename from docs/developers/bindings/PythonTypes.rst rename to docs/api/bindings/PythonTypes.rst diff --git a/docs/ChangeLog.rst b/docs/api/change_log.rst similarity index 68% rename from docs/ChangeLog.rst rename to docs/api/change_log.rst index b6b0dfd030..e011f774ad 100755 --- a/docs/ChangeLog.rst +++ b/docs/api/change_log.rst @@ -4,7 +4,7 @@ .. _changelog-main: -ChangeLog -========= +Change Log +========== -.. include:: CHANGELOG.md +.. include:: ../../CHANGELOG.md diff --git a/docs/installation.rst b/docs/api/installation.rst similarity index 100% rename from docs/installation.rst rename to docs/api/installation.rst diff --git a/docs/concepts/_index.rst b/docs/concepts/_index.rst new file mode 100644 index 0000000000..8c866a1e52 --- /dev/null +++ b/docs/concepts/_index.rst @@ -0,0 +1,14 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +Concepts +======== + +.. toctree:: + :caption: Concepts + + overview/introduction + overview/internal_architecture + overview/configuration_files + publications/cinematic_color \ No newline at end of file diff --git a/docs/concepts/overview/configuration_files.rst b/docs/concepts/overview/configuration_files.rst new file mode 100644 index 0000000000..99d94e6893 --- /dev/null +++ b/docs/concepts/overview/configuration_files.rst @@ -0,0 +1,6 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +Configuration Files +=================== \ No newline at end of file diff --git a/docs/developers/internal_architecture.rst b/docs/concepts/overview/internal_architecture.rst similarity index 100% rename from docs/developers/internal_architecture.rst rename to docs/concepts/overview/internal_architecture.rst diff --git a/docs/introduction.rst b/docs/concepts/overview/introduction.rst similarity index 100% rename from docs/introduction.rst rename to docs/concepts/overview/introduction.rst diff --git a/docs/concepts/publications/cinematic_color.rst b/docs/concepts/publications/cinematic_color.rst new file mode 100644 index 0000000000..9c6d1b927c --- /dev/null +++ b/docs/concepts/publications/cinematic_color.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +.. _introduction: + +Cinematic Color +=============== \ No newline at end of file diff --git a/docs/conf.py.in b/docs/conf.py similarity index 59% rename from docs/conf.py.in rename to docs/conf.py index 2a8ddfd0b0..1f0272867c 100644 --- a/docs/conf.py.in +++ b/docs/conf.py @@ -7,26 +7,31 @@ import sys, os -# -- Add PyOpenColorIO to sys.path +# -- Add PyOpenColorIO to sys.path --------------------------------------------- + sys.path.insert(0, "@CMAKE_BINARY_DIR@/src/pyglue") # -- General configuration ----------------------------------------------------- -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.ifconfig'] + +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.todo', + 'sphinx.ext.ifconfig', + 'sphinx.ext.napoleon', + # 'sphinx_tabs.tabs', + 'recommonmark', +] templates_path = ['templates'] -source_suffix = '.rst' +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown', + '.txt': 'markdown', +} master_doc = 'index' project = u'OpenColorIO' copyright = u'Copyright Contributors to the OpenColorIO Project' -# The short X.Y version. -version = '@OCIO_VERSION_MAJOR@.@OCIO_VERSION_MINOR@' -# The full version, including alpha/beta/rc tags. -release = '@OCIO_VERSION@' + exclude_patterns = ['build', '*-prefix'] -#add_function_parentheses = True -#add_module_names = True -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' -#modindex_common_prefix = [] rst_prolog = """ .. |OCIO| replace:: *OCIO* @@ -39,32 +44,36 @@ .. _ocio-dev: https://lists.aswf.io/g/ocio-dev """ +# -- Extension Configuration --------------------------------------------------- + +# Pygments +pygments_style = 'friendly' + +# # Breathe +# breathe_projects = { +# u'OpenColorIO': "./_doxygen/xml" +# } +# breathe_default_project = u'OpenColorIO' + +# Napoleon +napoleon_use_param = False +napoleon_include_init_with_doc = True + + # -- Options for HTML output --------------------------------------------------- -html_theme_path = ['.'] -html_theme = 'ociotheme' -#html_theme_options = {} -#html_title = None -#html_short_title = None -#html_logo = None -#html_favicon = None -html_static_path = [] -#html_last_updated_fmt = '%b %d, %Y' -#html_use_smartypants = True -#html_sidebars = {} -#html_additional_pages = {} -html_domain_indices = ['cpp-modindex', 'py-modindex'] -#html_use_index = True -#html_split_index = False -#html_show_sourcelink = True -#html_show_sphinx = True -#html_show_copyright = True -#html_use_opensearch = '' -#html_file_suffix = None -htmlhelp_basename = 'OpenColorIOdoc' + +html_theme = 'press' +html_logo = '_static/OpenColorIO_withText.svg' +html_static_path = ['_static'] + +html_theme_options = { + "external_links": [ + ("Github", "https://github.com/AcademySoftwareFoundation/OpenColorIO"), + ] +} # -- Options for LaTeX output -------------------------------------------------- -#latex_paper_size = 'letter' -#latex_font_size = '10pt' + latex_documents = [ ('index', 'OpenColorIO.tex', u'OpenColorIO Documentation', u'Academy Software Foundation', 'manual', False), @@ -74,21 +83,17 @@ 'footer': 'test...123' } -#latex_logo = None -#latex_use_parts = False -#latex_show_pagerefs = False -#latex_show_urls = False -#latex_preamble = '\setcounter{tocdepth}{2}' -#latex_appendices = [] latex_domain_indices = ['cpp-modindex', 'py-modindex'] # -- Options for manual page output -------------------------------------------- + man_pages = [ ('index', 'opencolorio', u'OpenColorIO Documentation', [u'Academy Software Foundation'], 1) ] # -- Options for Texinfo output ------------------------------------------------ + texinfo_documents = [ ('index', 'OpenColorIO', u'OpenColorIO Documentation', u'Academy Software Foundation', 'OpenColorIO', 'One line description of project.', 'Miscellaneous'), @@ -96,17 +101,8 @@ texinfo_appendices = [] # -- Options for Epub output --------------------------------------------------- + epub_title = u'OpenColorIO' epub_author = u'Contributors to the OpenColorIO Project' epub_publisher = u'Contributors to the OpenColorIO Project' -epub_copyright = u'Copyright Contributors to the OpenColorIO Project' -#epub_language = '' -#epub_scheme = '' -#epub_identifier = '' -#epub_uid = '' -#epub_cover = () -#epub_pre_files = [] -#epub_post_files = [] -#epub_exclude_files = [] -#epub_tocdepth = 3 -#epub_tocdup = True +epub_copyright = u'Copyright Contributors to the OpenColorIO Project' \ No newline at end of file diff --git a/docs/configurations/index.rst b/docs/configurations/index.rst deleted file mode 100644 index 4f3e92090a..0000000000 --- a/docs/configurations/index.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. _configurations: - -Configurations -============== - -This section gives an overview of what existing (public) OCIO configurations exist, -and how to create new ones. - -OCIO Configurations can be downloaded here: `.zip `__ `.tar.gz `__ (OCIO v1.0+) - -If you are interested in crafting custom color configurations, and need assistance, please contact: `ocio-user `__\. - -Public Configs -************** - -.. toctree:: - :maxdepth: 1 - - spi_vfx - spi_anim - nuke_default - aces_1.0.3 - -Config Creation -*************** - -.. toctree:: - :maxdepth: 1 - - allocation_vars diff --git a/docs/developers/index.rst b/docs/developers/index.rst deleted file mode 100644 index 473372d872..0000000000 --- a/docs/developers/index.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. _developer-guide: - -Developer Guide -=============== - -Some information on contributing to OCIO: - -.. toctree:: - :maxdepth: 1 - - getting_started - coding_guidelines - documentation_guidelines - submitting_changes - issues - -Instructions on using OCIO: - -.. toctree:: - :maxdepth: 1 - - usage_examples - -C++ API documentation: - -.. toctree:: - :maxdepth: 1 - - api/index - -Python API documentation: - -.. toctree:: - :maxdepth: 1 - - bindings/PythonAPI - bindings/PythonTransforms - bindings/PythonTypes - -Internal Architecture: - -.. toctree:: - :maxdepth: 1 - - internal_architecture - diff --git a/docs/guides/_index.rst b/docs/guides/_index.rst new file mode 100644 index 0000000000..c5f9c7e76a --- /dev/null +++ b/docs/guides/_index.rst @@ -0,0 +1,22 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +Guides +====== + +.. toctree:: + :caption: Guides + + using_ocio/compatible_software + authoring/config_syntax + authoring/looks + authoring/contexts + authoring/allocation_vars + integration/usage_examples + contributing/coding_guidelines + contributing/documentation_guidelines + contributing/doxygen_style_guide + contributing/getting_started + contributing/issues + contributing/submitting_changes \ No newline at end of file diff --git a/docs/configurations/allocation_vars.rst b/docs/guides/authoring/allocation_vars.rst similarity index 100% rename from docs/configurations/allocation_vars.rst rename to docs/guides/authoring/allocation_vars.rst diff --git a/docs/userguide/config_syntax.rst b/docs/guides/authoring/config_syntax.rst similarity index 100% rename from docs/userguide/config_syntax.rst rename to docs/guides/authoring/config_syntax.rst diff --git a/docs/userguide/contexts.rst b/docs/guides/authoring/contexts.rst similarity index 100% rename from docs/userguide/contexts.rst rename to docs/guides/authoring/contexts.rst diff --git a/docs/userguide/looks.rst b/docs/guides/authoring/looks.rst similarity index 100% rename from docs/userguide/looks.rst rename to docs/guides/authoring/looks.rst diff --git a/docs/aswf/CLA-corporate.md b/docs/guides/contributing/aswf/CLA-corporate.md similarity index 100% rename from docs/aswf/CLA-corporate.md rename to docs/guides/contributing/aswf/CLA-corporate.md diff --git a/docs/aswf/CLA-individual.md b/docs/guides/contributing/aswf/CLA-individual.md similarity index 100% rename from docs/aswf/CLA-individual.md rename to docs/guides/contributing/aswf/CLA-individual.md diff --git a/docs/aswf/Charter.md b/docs/guides/contributing/aswf/Charter.md similarity index 100% rename from docs/aswf/Charter.md rename to docs/guides/contributing/aswf/Charter.md diff --git a/docs/aswf/DCO.md b/docs/guides/contributing/aswf/DCO.md similarity index 100% rename from docs/aswf/DCO.md rename to docs/guides/contributing/aswf/DCO.md diff --git a/docs/developers/coding_guidelines.rst b/docs/guides/contributing/coding_guidelines.rst similarity index 100% rename from docs/developers/coding_guidelines.rst rename to docs/guides/contributing/coding_guidelines.rst diff --git a/docs/developers/documentation_guidelines.rst b/docs/guides/contributing/documentation_guidelines.rst similarity index 100% rename from docs/developers/documentation_guidelines.rst rename to docs/guides/contributing/documentation_guidelines.rst diff --git a/docs/developers/doxygen_style_guide.rst b/docs/guides/contributing/doxygen_style_guide.rst similarity index 100% rename from docs/developers/doxygen_style_guide.rst rename to docs/guides/contributing/doxygen_style_guide.rst diff --git a/docs/developers/getting_started.rst b/docs/guides/contributing/getting_started.rst similarity index 100% rename from docs/developers/getting_started.rst rename to docs/guides/contributing/getting_started.rst diff --git a/docs/developers/issues.rst b/docs/guides/contributing/issues.rst similarity index 100% rename from docs/developers/issues.rst rename to docs/guides/contributing/issues.rst diff --git a/docs/developers/submitting_changes.rst b/docs/guides/contributing/submitting_changes.rst similarity index 100% rename from docs/developers/submitting_changes.rst rename to docs/guides/contributing/submitting_changes.rst diff --git a/docs/tsc/meetings/2019-02-04.md b/docs/guides/contributing/tsc/meetings/2019-02-04.md similarity index 100% rename from docs/tsc/meetings/2019-02-04.md rename to docs/guides/contributing/tsc/meetings/2019-02-04.md diff --git a/docs/tsc/meetings/2019-02-11.md b/docs/guides/contributing/tsc/meetings/2019-02-11.md similarity index 100% rename from docs/tsc/meetings/2019-02-11.md rename to docs/guides/contributing/tsc/meetings/2019-02-11.md diff --git a/docs/tsc/meetings/2019-02-25.md b/docs/guides/contributing/tsc/meetings/2019-02-25.md similarity index 100% rename from docs/tsc/meetings/2019-02-25.md rename to docs/guides/contributing/tsc/meetings/2019-02-25.md diff --git a/docs/tsc/meetings/2019-03-04.md b/docs/guides/contributing/tsc/meetings/2019-03-04.md similarity index 100% rename from docs/tsc/meetings/2019-03-04.md rename to docs/guides/contributing/tsc/meetings/2019-03-04.md diff --git a/docs/tsc/meetings/2019-03-11.md b/docs/guides/contributing/tsc/meetings/2019-03-11.md similarity index 100% rename from docs/tsc/meetings/2019-03-11.md rename to docs/guides/contributing/tsc/meetings/2019-03-11.md diff --git a/docs/tsc/meetings/2019-03-18.md b/docs/guides/contributing/tsc/meetings/2019-03-18.md similarity index 100% rename from docs/tsc/meetings/2019-03-18.md rename to docs/guides/contributing/tsc/meetings/2019-03-18.md diff --git a/docs/tsc/meetings/2019-03-25.md b/docs/guides/contributing/tsc/meetings/2019-03-25.md similarity index 100% rename from docs/tsc/meetings/2019-03-25.md rename to docs/guides/contributing/tsc/meetings/2019-03-25.md diff --git a/docs/tsc/meetings/2019-04-01.md b/docs/guides/contributing/tsc/meetings/2019-04-01.md similarity index 100% rename from docs/tsc/meetings/2019-04-01.md rename to docs/guides/contributing/tsc/meetings/2019-04-01.md diff --git a/docs/tsc/meetings/2019-04-08.md b/docs/guides/contributing/tsc/meetings/2019-04-08.md similarity index 100% rename from docs/tsc/meetings/2019-04-08.md rename to docs/guides/contributing/tsc/meetings/2019-04-08.md diff --git a/docs/tsc/meetings/2019-04-15.md b/docs/guides/contributing/tsc/meetings/2019-04-15.md similarity index 100% rename from docs/tsc/meetings/2019-04-15.md rename to docs/guides/contributing/tsc/meetings/2019-04-15.md diff --git a/docs/tsc/meetings/2019-04-29.md b/docs/guides/contributing/tsc/meetings/2019-04-29.md similarity index 100% rename from docs/tsc/meetings/2019-04-29.md rename to docs/guides/contributing/tsc/meetings/2019-04-29.md diff --git a/docs/tsc/meetings/2019-05-06.md b/docs/guides/contributing/tsc/meetings/2019-05-06.md similarity index 100% rename from docs/tsc/meetings/2019-05-06.md rename to docs/guides/contributing/tsc/meetings/2019-05-06.md diff --git a/docs/tsc/meetings/2019-05-13.md b/docs/guides/contributing/tsc/meetings/2019-05-13.md similarity index 100% rename from docs/tsc/meetings/2019-05-13.md rename to docs/guides/contributing/tsc/meetings/2019-05-13.md diff --git a/docs/tsc/meetings/2019-05-27.md b/docs/guides/contributing/tsc/meetings/2019-05-27.md similarity index 100% rename from docs/tsc/meetings/2019-05-27.md rename to docs/guides/contributing/tsc/meetings/2019-05-27.md diff --git a/docs/tsc/meetings/2019-06-03.md b/docs/guides/contributing/tsc/meetings/2019-06-03.md similarity index 100% rename from docs/tsc/meetings/2019-06-03.md rename to docs/guides/contributing/tsc/meetings/2019-06-03.md diff --git a/docs/tsc/meetings/2019-06-10.md b/docs/guides/contributing/tsc/meetings/2019-06-10.md similarity index 100% rename from docs/tsc/meetings/2019-06-10.md rename to docs/guides/contributing/tsc/meetings/2019-06-10.md diff --git a/docs/tsc/meetings/2019-06-17.md b/docs/guides/contributing/tsc/meetings/2019-06-17.md similarity index 100% rename from docs/tsc/meetings/2019-06-17.md rename to docs/guides/contributing/tsc/meetings/2019-06-17.md diff --git a/docs/tsc/meetings/2019-07-08.md b/docs/guides/contributing/tsc/meetings/2019-07-08.md similarity index 100% rename from docs/tsc/meetings/2019-07-08.md rename to docs/guides/contributing/tsc/meetings/2019-07-08.md diff --git a/docs/tsc/meetings/2019-07-22.md b/docs/guides/contributing/tsc/meetings/2019-07-22.md similarity index 100% rename from docs/tsc/meetings/2019-07-22.md rename to docs/guides/contributing/tsc/meetings/2019-07-22.md diff --git a/docs/tsc/meetings/2019-07-31.md b/docs/guides/contributing/tsc/meetings/2019-07-31.md similarity index 100% rename from docs/tsc/meetings/2019-07-31.md rename to docs/guides/contributing/tsc/meetings/2019-07-31.md diff --git a/docs/tsc/meetings/2019-08-05.md b/docs/guides/contributing/tsc/meetings/2019-08-05.md similarity index 100% rename from docs/tsc/meetings/2019-08-05.md rename to docs/guides/contributing/tsc/meetings/2019-08-05.md diff --git a/docs/tsc/meetings/2019-08-12.md b/docs/guides/contributing/tsc/meetings/2019-08-12.md similarity index 100% rename from docs/tsc/meetings/2019-08-12.md rename to docs/guides/contributing/tsc/meetings/2019-08-12.md diff --git a/docs/tsc/meetings/2019-08-19.md b/docs/guides/contributing/tsc/meetings/2019-08-19.md similarity index 100% rename from docs/tsc/meetings/2019-08-19.md rename to docs/guides/contributing/tsc/meetings/2019-08-19.md diff --git a/docs/tsc/meetings/2019-09-09.md b/docs/guides/contributing/tsc/meetings/2019-09-09.md similarity index 100% rename from docs/tsc/meetings/2019-09-09.md rename to docs/guides/contributing/tsc/meetings/2019-09-09.md diff --git a/docs/tsc/meetings/2019-09-16.md b/docs/guides/contributing/tsc/meetings/2019-09-16.md similarity index 100% rename from docs/tsc/meetings/2019-09-16.md rename to docs/guides/contributing/tsc/meetings/2019-09-16.md diff --git a/docs/tsc/meetings/2019-09-23.md b/docs/guides/contributing/tsc/meetings/2019-09-23.md similarity index 100% rename from docs/tsc/meetings/2019-09-23.md rename to docs/guides/contributing/tsc/meetings/2019-09-23.md diff --git a/docs/tsc/meetings/2019-09-30.md b/docs/guides/contributing/tsc/meetings/2019-09-30.md similarity index 100% rename from docs/tsc/meetings/2019-09-30.md rename to docs/guides/contributing/tsc/meetings/2019-09-30.md diff --git a/docs/tsc/meetings/2019-10-07.md b/docs/guides/contributing/tsc/meetings/2019-10-07.md similarity index 100% rename from docs/tsc/meetings/2019-10-07.md rename to docs/guides/contributing/tsc/meetings/2019-10-07.md diff --git a/docs/tsc/meetings/2019-10-21.md b/docs/guides/contributing/tsc/meetings/2019-10-21.md similarity index 100% rename from docs/tsc/meetings/2019-10-21.md rename to docs/guides/contributing/tsc/meetings/2019-10-21.md diff --git a/docs/tsc/meetings/2019-10-28.md b/docs/guides/contributing/tsc/meetings/2019-10-28.md similarity index 100% rename from docs/tsc/meetings/2019-10-28.md rename to docs/guides/contributing/tsc/meetings/2019-10-28.md diff --git a/docs/tsc/meetings/2019-11-04.md b/docs/guides/contributing/tsc/meetings/2019-11-04.md similarity index 100% rename from docs/tsc/meetings/2019-11-04.md rename to docs/guides/contributing/tsc/meetings/2019-11-04.md diff --git a/docs/tsc/meetings/2019-11-18.md b/docs/guides/contributing/tsc/meetings/2019-11-18.md similarity index 100% rename from docs/tsc/meetings/2019-11-18.md rename to docs/guides/contributing/tsc/meetings/2019-11-18.md diff --git a/docs/tsc/meetings/2019-11-25.md b/docs/guides/contributing/tsc/meetings/2019-11-25.md similarity index 100% rename from docs/tsc/meetings/2019-11-25.md rename to docs/guides/contributing/tsc/meetings/2019-11-25.md diff --git a/docs/tsc/meetings/2019-12-09.md b/docs/guides/contributing/tsc/meetings/2019-12-09.md similarity index 100% rename from docs/tsc/meetings/2019-12-09.md rename to docs/guides/contributing/tsc/meetings/2019-12-09.md diff --git a/docs/tsc/meetings/2019-12-16.md b/docs/guides/contributing/tsc/meetings/2019-12-16.md similarity index 100% rename from docs/tsc/meetings/2019-12-16.md rename to docs/guides/contributing/tsc/meetings/2019-12-16.md diff --git a/docs/tsc/meetings/2020-01-06.md b/docs/guides/contributing/tsc/meetings/2020-01-06.md similarity index 100% rename from docs/tsc/meetings/2020-01-06.md rename to docs/guides/contributing/tsc/meetings/2020-01-06.md diff --git a/docs/tsc/meetings/2020-01-13.md b/docs/guides/contributing/tsc/meetings/2020-01-13.md similarity index 100% rename from docs/tsc/meetings/2020-01-13.md rename to docs/guides/contributing/tsc/meetings/2020-01-13.md diff --git a/docs/tsc/meetings/2020-01-20.md b/docs/guides/contributing/tsc/meetings/2020-01-20.md similarity index 100% rename from docs/tsc/meetings/2020-01-20.md rename to docs/guides/contributing/tsc/meetings/2020-01-20.md diff --git a/docs/tsc/meetings/2020-01-27.md b/docs/guides/contributing/tsc/meetings/2020-01-27.md similarity index 100% rename from docs/tsc/meetings/2020-01-27.md rename to docs/guides/contributing/tsc/meetings/2020-01-27.md diff --git a/docs/tsc/meetings/2020-02-03.md b/docs/guides/contributing/tsc/meetings/2020-02-03.md similarity index 100% rename from docs/tsc/meetings/2020-02-03.md rename to docs/guides/contributing/tsc/meetings/2020-02-03.md diff --git a/docs/tsc/meetings/2020-02-10.md b/docs/guides/contributing/tsc/meetings/2020-02-10.md similarity index 100% rename from docs/tsc/meetings/2020-02-10.md rename to docs/guides/contributing/tsc/meetings/2020-02-10.md diff --git a/docs/tsc/meetings/2020-02-24.md b/docs/guides/contributing/tsc/meetings/2020-02-24.md similarity index 100% rename from docs/tsc/meetings/2020-02-24.md rename to docs/guides/contributing/tsc/meetings/2020-02-24.md diff --git a/docs/tsc/meetings/2020-03-02.md b/docs/guides/contributing/tsc/meetings/2020-03-02.md similarity index 100% rename from docs/tsc/meetings/2020-03-02.md rename to docs/guides/contributing/tsc/meetings/2020-03-02.md diff --git a/docs/tsc/meetings/2020-03-09.md b/docs/guides/contributing/tsc/meetings/2020-03-09.md similarity index 100% rename from docs/tsc/meetings/2020-03-09.md rename to docs/guides/contributing/tsc/meetings/2020-03-09.md diff --git a/docs/tsc/meetings/2020-03-16.md b/docs/guides/contributing/tsc/meetings/2020-03-16.md similarity index 100% rename from docs/tsc/meetings/2020-03-16.md rename to docs/guides/contributing/tsc/meetings/2020-03-16.md diff --git a/docs/tsc/meetings/2020-03-23.md b/docs/guides/contributing/tsc/meetings/2020-03-23.md similarity index 100% rename from docs/tsc/meetings/2020-03-23.md rename to docs/guides/contributing/tsc/meetings/2020-03-23.md diff --git a/docs/tsc/meetings/2020-03-30.md b/docs/guides/contributing/tsc/meetings/2020-03-30.md similarity index 100% rename from docs/tsc/meetings/2020-03-30.md rename to docs/guides/contributing/tsc/meetings/2020-03-30.md diff --git a/docs/tsc/meetings/2020-04-06.md b/docs/guides/contributing/tsc/meetings/2020-04-06.md similarity index 100% rename from docs/tsc/meetings/2020-04-06.md rename to docs/guides/contributing/tsc/meetings/2020-04-06.md diff --git a/docs/tsc/meetings/2020-04-20.md b/docs/guides/contributing/tsc/meetings/2020-04-20.md similarity index 100% rename from docs/tsc/meetings/2020-04-20.md rename to docs/guides/contributing/tsc/meetings/2020-04-20.md diff --git a/docs/tsc/meetings/2020-04-27.md b/docs/guides/contributing/tsc/meetings/2020-04-27.md similarity index 100% rename from docs/tsc/meetings/2020-04-27.md rename to docs/guides/contributing/tsc/meetings/2020-04-27.md diff --git a/docs/tsc/meetings/2020-05-04.md b/docs/guides/contributing/tsc/meetings/2020-05-04.md similarity index 100% rename from docs/tsc/meetings/2020-05-04.md rename to docs/guides/contributing/tsc/meetings/2020-05-04.md diff --git a/docs/tsc/meetings/2020-05-11.md b/docs/guides/contributing/tsc/meetings/2020-05-11.md similarity index 100% rename from docs/tsc/meetings/2020-05-11.md rename to docs/guides/contributing/tsc/meetings/2020-05-11.md diff --git a/docs/tsc/meetings/2020-05-18.md b/docs/guides/contributing/tsc/meetings/2020-05-18.md similarity index 100% rename from docs/tsc/meetings/2020-05-18.md rename to docs/guides/contributing/tsc/meetings/2020-05-18.md diff --git a/docs/tsc/meetings/2020-06-01.md b/docs/guides/contributing/tsc/meetings/2020-06-01.md similarity index 100% rename from docs/tsc/meetings/2020-06-01.md rename to docs/guides/contributing/tsc/meetings/2020-06-01.md diff --git a/docs/tsc/meetings/2020-06-08.md b/docs/guides/contributing/tsc/meetings/2020-06-08.md similarity index 100% rename from docs/tsc/meetings/2020-06-08.md rename to docs/guides/contributing/tsc/meetings/2020-06-08.md diff --git a/docs/tsc/meetings/2020-06-22.md b/docs/guides/contributing/tsc/meetings/2020-06-22.md similarity index 100% rename from docs/tsc/meetings/2020-06-22.md rename to docs/guides/contributing/tsc/meetings/2020-06-22.md diff --git a/docs/tsc/meetings/2020-06-29.md b/docs/guides/contributing/tsc/meetings/2020-06-29.md similarity index 100% rename from docs/tsc/meetings/2020-06-29.md rename to docs/guides/contributing/tsc/meetings/2020-06-29.md diff --git a/docs/tsc/meetings/2020-07-13.md b/docs/guides/contributing/tsc/meetings/2020-07-13.md similarity index 100% rename from docs/tsc/meetings/2020-07-13.md rename to docs/guides/contributing/tsc/meetings/2020-07-13.md diff --git a/docs/tsc/meetings/2020_07_06.md b/docs/guides/contributing/tsc/meetings/2020_07_06.md similarity index 100% rename from docs/tsc/meetings/2020_07_06.md rename to docs/guides/contributing/tsc/meetings/2020_07_06.md diff --git a/docs/tsc/meetings/template.md b/docs/guides/contributing/tsc/meetings/template.md similarity index 100% rename from docs/tsc/meetings/template.md rename to docs/guides/contributing/tsc/meetings/template.md diff --git a/docs/tsc/working_groups/configs/2020-06-16.md b/docs/guides/contributing/tsc/working_groups/configs/2020-06-16.md similarity index 100% rename from docs/tsc/working_groups/configs/2020-06-16.md rename to docs/guides/contributing/tsc/working_groups/configs/2020-06-16.md diff --git a/docs/tsc/working_groups/configs/2020-06-30.md b/docs/guides/contributing/tsc/working_groups/configs/2020-06-30.md similarity index 100% rename from docs/tsc/working_groups/configs/2020-06-30.md rename to docs/guides/contributing/tsc/working_groups/configs/2020-06-30.md diff --git a/docs/tsc/working_groups/documentation/2020-06-12.md b/docs/guides/contributing/tsc/working_groups/documentation/2020-06-12.md similarity index 100% rename from docs/tsc/working_groups/documentation/2020-06-12.md rename to docs/guides/contributing/tsc/working_groups/documentation/2020-06-12.md diff --git a/docs/tsc/working_groups/documentation/2020-06-19.md b/docs/guides/contributing/tsc/working_groups/documentation/2020-06-19.md similarity index 100% rename from docs/tsc/working_groups/documentation/2020-06-19.md rename to docs/guides/contributing/tsc/working_groups/documentation/2020-06-19.md diff --git a/docs/developers/usage_examples.rst b/docs/guides/integration/usage_examples.rst similarity index 100% rename from docs/developers/usage_examples.rst rename to docs/guides/integration/usage_examples.rst diff --git a/docs/CompatibleSoftware.rst b/docs/guides/using_ocio/compatible_software.rst similarity index 100% rename from docs/CompatibleSoftware.rst rename to docs/guides/using_ocio/compatible_software.rst diff --git a/docs/index.rst b/docs/index.rst index d96e5d8b90..ea87ca2c4b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,8 +2,15 @@ SPDX-License-Identifier: CC-BY-4.0 Copyright Contributors to the OpenColorIO Project. -Home -==== + +.. .. raw:: html + +.. + + + +Overview +======== OpenColorIO (OCIO) is a complete color management solution geared towards motion picture production with an emphasis on visual effects and computer animation. @@ -20,19 +27,9 @@ films as SpiderMan 2 (2004), Surf's Up (2007), Cloudy with a Chance of Meatballs supported in commercial applications like Katana, Mari, Nuke, Silhouette FX, and others. -.. _mailing_lists: - -Mailing Lists -************* -There are two mailing lists associated with OpenColorIO: - -`ocio-user `__\ ``@lists.aswf.io`` - For end users (artists, often) interested in OCIO profile design, - facility color management, and workflow. - -`ocio-dev `__\ ``@lists.aswf.io`` - For developers interested OCIO APIs, code integration, compilation, etc. +Users +===== Quick Start *********** @@ -57,42 +54,28 @@ typically requires a different profile than animated features). If you need assistance picking a profile, email `ocio-user `__\. -Downloading and Building the Code -********************************* - -Source code is available on Github at -http://github.com/AcademySoftwareFoundation/OpenColorIO - -Download a `.zip `_ or -`.tar.gz `_ of the -current state of the repository. - -Please see the :ref:`developer-guide` for more info, and contact `ocio-dev -`__\ with any questions. - -.. toctree:: - :hidden: - :maxdepth: 2 - - self - introduction - - configurations/index - installation - - userguide/index - - developers/index - - CompatibleSoftware - FAQ - downloads - - ChangeLog - License - --------------------------------------------------------------------------------- +Community +========= + +.. _mailing_lists: + +Mailing Lists +************* + +There are two mailing lists associated with OpenColorIO: + +`ocio-user `__\ ``@lists.aswf.io`` + For end users (artists, often) interested in OCIO profile design, + facility color management, and workflow. + +`ocio-dev `__\ ``@lists.aswf.io`` + For developers interested OCIO APIs, code integration, compilation, etc. + + +.. include:: toc_redirect.rst + + :ref:`search` :ref:`genindex` diff --git a/docs/License.rst b/docs/license_info/License.rst similarity index 100% rename from docs/License.rst rename to docs/license_info/License.rst diff --git a/docs/developers/api/index.rst b/docs/license_info/_index.rst similarity index 56% rename from docs/developers/api/index.rst rename to docs/license_info/_index.rst index c65b610309..f69c8db39d 100644 --- a/docs/developers/api/index.rst +++ b/docs/license_info/_index.rst @@ -2,9 +2,10 @@ SPDX-License-Identifier: CC-BY-4.0 Copyright Contributors to the OpenColorIO Project. +License +======= + .. toctree:: - :maxdepth: 1 - - OpenColorIO - OpenColorTransforms - OpenColorTypes + :caption: License + + license \ No newline at end of file diff --git a/docs/ociotheme/layout.html b/docs/ociotheme/layout.html deleted file mode 100644 index 6d2cdee5a8..0000000000 --- a/docs/ociotheme/layout.html +++ /dev/null @@ -1,74 +0,0 @@ -{# - haiku/layout.html - ~~~~~~~~~~~~~~~~~ - - Sphinx layout template for the haiku theme. - - :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. -#} -{% extends "basic/layout.html" %} -{% set script_files = script_files + ['_static/theme_extras.js'] %} -{% set css_files = css_files + ['_static/print.css'] %} - -{% block relbar1 %}{% endblock %} -{% block relbar2 %}{% endblock %} - -{% block htmltitle %} - OpenColorIO -{% endblock %} - -{% macro nav() %} -

- {%- block haikurel1 %} - {%- endblock %} - {%- block haikurel2 %} - {%- endblock %} -

-{% endmacro %} - -{% block content %} -
- {%- block haikuheader %} - {%- if theme_full_logo != "false" %} - - - - {%- else %} - {%- if logo -%} - - {%- endif -%} -

- OpenColorIO

-

Open Source Color Management

- {%- endif %} - {%- endblock %} -
-
- {{ shorttitle|e }} -
-
- {#{%- if display_toc %} -
-

Table Of Contents

- {{ toc }} -
- {%- endif %}#} - - - - -
-
- {{ toctree(includehidden=1) }} - {%- include "searchbox.html" %} -
- 		- {% block body %}{% endblock %} -
-
-
-
- {{ nav() }} -
-{% endblock %} diff --git a/docs/ociotheme/page.html b/docs/ociotheme/page.html deleted file mode 100644 index ec7f5cf379..0000000000 --- a/docs/ociotheme/page.html +++ /dev/null @@ -1,29 +0,0 @@ -{# - basic/page.html - ~~~~~~~~~~~~~~~ - - Master template for simple pages. - - :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. -#} -{% extends "layout.html" %} -{% block body %} -{{ body }} - {% if pagename == "index" %} - -
-

Color Transform Example

- -
Final Image: sRGB
- -
Digital Intermediate (DI): log dpx
- -
Render: scene-linear exr
-

Images from "Cloudy With A Chance of Meatballs"

-

Copyright 2011 Sony Pictures Inc. All Rights Reserved.

-

spi-animation profile, available here.

-
- - {% endif %} -{% endblock %} diff --git a/docs/ociotheme/searchbox.html b/docs/ociotheme/searchbox.html deleted file mode 100644 index 38f4ab8992..0000000000 --- a/docs/ociotheme/searchbox.html +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - diff --git a/docs/ociotheme/static/alert_info_32.png b/docs/ociotheme/static/alert_info_32.png deleted file mode 100644 index 05b4fe898c..0000000000 Binary files a/docs/ociotheme/static/alert_info_32.png and /dev/null differ diff --git a/docs/ociotheme/static/alert_warning_32.png b/docs/ociotheme/static/alert_warning_32.png deleted file mode 100644 index f13611cde4..0000000000 Binary files a/docs/ociotheme/static/alert_warning_32.png and /dev/null differ diff --git a/docs/ociotheme/static/bg-page.png b/docs/ociotheme/static/bg-page.png deleted file mode 100644 index c6f3bc477c..0000000000 Binary files a/docs/ociotheme/static/bg-page.png and /dev/null differ diff --git a/docs/ociotheme/static/bullet_orange.png b/docs/ociotheme/static/bullet_orange.png deleted file mode 100644 index 7171fd597c..0000000000 Binary files a/docs/ociotheme/static/bullet_orange.png and /dev/null differ diff --git a/docs/ociotheme/static/ocio.css_t b/docs/ociotheme/static/ocio.css_t deleted file mode 100644 index b1ca6109f7..0000000000 --- a/docs/ociotheme/static/ocio.css_t +++ /dev/null @@ -1,471 +0,0 @@ -/* - * haiku.css_t - * ~~~~~~~~~~~ - * - * Sphinx stylesheet -- haiku theme. - * - * Adapted from http://haiku-os.org/docs/Haiku-doc.css. - * Original copyright message: - * - * Copyright 2008-2009, Haiku. All rights reserved. - * Distributed under the terms of the MIT License. - * - * Authors: - * Francois Revol - * Stephan Assmus - * Braden Ewing - * Humdinger - * - * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -@import url("basic.css"); - -html { - margin: 0px; - padding: 0px; - background: #FFF url(bg-page.png) top left repeat-x; -} - -body { - line-height: 1.5; - margin: auto; - padding: 0px; - font-family: "DejaVu Sans", Arial, Helvetica, sans-serif; - min-width: 59em; - color: {{ theme_textcolor }}; -} - -div.footer { - /* padding: 8px; */ - font-size: 11px; - text-align: center; - letter-spacing: 0.5px; -} - -/* Sidebar */ - -/* link colors and text decoration */ - -a:link { - font-weight: bold; - text-decoration: none; - color: {{ theme_linkcolor }}; -} - -a:visited { - font-weight: bold; - text-decoration: none; - color: {{ theme_visitedlinkcolor }}; -} - -a:hover, a:active { - text-decoration: underline; - color: {{ theme_hoverlinkcolor }}; -} - -/* Some headers act as anchors, don't give them a hover effect */ - -h1 a:hover, a:active { - text-decoration: none; - color: {{ theme_headingcolor }}; -} - -h2 a:hover, a:active { - text-decoration: none; - color: {{ theme_headingcolor }}; -} - -h3 a:hover, a:active { - text-decoration: none; - color: {{ theme_headingcolor }}; -} - -h4 a:hover, a:active { - text-decoration: none; - color: {{ theme_headingcolor }}; -} - -a.headerlink { - color: #a7ce38; - padding-left: 5px; -} - -a.headerlink:hover { - color: #a7ce38; -} - -/* basic text elements */ - -div.content { - margin-top: 20px; - margin-left: 0px; - margin-right: 20px; - margin-bottom: 50px; - font-size: 0.9em; -} - -/* heading and navigation */ - -div.header { - position: relative; - left: 0px; - top: 0px; - height: 85px; - /* background: #eeeeee; */ - padding: 0 40px; -} -div.header h1 { - font-size: 1.6em; - font-weight: normal; - letter-spacing: 1px; - color: {{ theme_headingcolor }}; - border: 0; - margin: 0; - padding-top: 15px; -} -div.header h1 a { - font-weight: normal; - color: {{ theme_headingcolor }}; -} -div.header h2 { - font-size: 1.3em; - font-weight: normal; - letter-spacing: 1px; - text-transform: uppercase; - color: #aaa; - border: 0; - margin-top: -3px; - padding: 0; -} - -div.header img.rightlogo { - float: right; -} - - -div.title { - font-size: 1.3em; - font-weight: bold; - color: {{ theme_headingcolor }}; - border-bottom: dotted thin #e0e0e0; - margin-bottom: 25px; -} -div.topnav { - background: #e0e0e0; - font-size: 0.8em; - text-align: right; -} -div.topnav p { - margin-top: 0; - margin-left: 40px; - margin-right: 40px; - margin-bottom: 0px; - text-align: right; - font-size: 0.8em; -} -div.bottomnav { - background: #eeeeee; -} -div.bottomnav p { - margin-right: 40px; - text-align: right; - font-size: 0.8em; -} - -a.uplink { - font-weight: normal; -} - - -/* contents box */ - -table.index { - /*margin: 0px 0px 30px 30px;*/ - padding: 1px; - border-width: 1px; - border-style: dotted; - border-color: #e0e0e0; -} -table.index tr.heading { - background-color: #e0e0e0; - text-align: center; - font-weight: bold; - font-size: 1.1em; -} -table.index tr.index { - background-color: #eeeeee; -} -table.index td { - padding: 5px 20px; -} - -table.index a:link, table.index a:visited { - font-weight: normal; - text-decoration: none; - color: {{ theme_linkcolor }}; -} -table.index a:hover, table.index a:active { - text-decoration: underline; - color: {{ theme_hoverlinkcolor }}; -} - - -/* Haiku User Guide styles and layout */ - -/* Rounded corner boxes */ -/* Common declarations */ -div.admonition { - -webkit-border-radius: 10px; - -khtml-border-radius: 10px; - -moz-border-radius: 10px; - border-radius: 10px; - border-style: dotted; - border-width: thin; - border-color: #dcdcdc; - padding: 10px 15px 10px 15px; - margin-bottom: 15px; - margin-top: 15px; -} -div.note { - padding: 10px 15px 10px 80px; - background: #e4ffde url(alert_info_32.png) 15px 15px no-repeat; - min-height: 42px; -} -div.warning { - padding: 10px 15px 10px 80px; - background: #fffbc6 url(alert_warning_32.png) 15px 15px no-repeat; - min-height: 42px; -} -div.seealso { - background: #e4ffde; -} - -/* More layout and styles */ -h1 { - font-size: 1.7em; - font-weight: bold; - color: {{ theme_headingcolor }}; - border-bottom: dotted thin #e0e0e0; - margin-top: 30px; -} - -h2 { - font-size: 1.6em; - font-weight: normal; - color: {{ theme_headingcolor }}; - border-bottom: dotted thin #e0e0e0; - margin-top: 30px; -} - -h3 { - font-size: 1.4em; - font-weight: normal; - color: {{ theme_headingcolor }}; - border-bottom: dotted thin #e0e0e0; - margin-top: 30px; -} - -h4 { - font-size: 1.2em; - font-weight: normal; - color: {{ theme_headingcolor }}; - border-bottom: dotted thin #e0e0e0; - margin-top: 30px; -} - -p { - text-align: justify; -} - -p.last { - margin-bottom: 0; -} - -ol { - padding-left: 20px; -} - -ul { - padding-left: 5px; - margin-top: 3px; -} - -li { - line-height: 1.3; -} - -div.content ul > li { - -moz-background-clip:border; - -moz-background-inline-policy:continuous; - -moz-background-origin:padding; - background: transparent url(bullet_orange.png) no-repeat scroll left 0.45em; - list-style-image: none; - list-style-type: none; - padding: 0 0 0 1.666em; - margin-bottom: 3px; - font-weight: normal; -} - -td { - vertical-align: top; -} - -tt { - background-color: #e2e2e2; - font-size: 1.0em; - font-family: monospace; -} - -pre { - border-color: #0c3762; - border-style: dotted; - border-width: thin; - margin: 0 0 12px 0; - padding: 0.8em; - background-color: #f0f0f0; -} - -hr { - border-top: 1px solid #ccc; - border-bottom: 0; - border-right: 0; - border-left: 0; - margin-bottom: 10px; - margin-top: 20px; -} - -/* printer only pretty stuff */ -@media print { - .noprint { - display: none; - } - /* for acronyms we want their definitions inlined at print time */ - acronym[title]:after { - font-size: small; - content: " (" attr(title) ")"; - font-style: italic; - } - /* and not have mozilla dotted underline */ - acronym { - border: none; - } - div.topnav, div.bottomnav, div.header, table.index { - display: none; - } - div.content { - margin: 0px; - padding: 0px; - } - html { - background: #FFF; - } -} - -.viewcode-back { - font-family: "DejaVu Sans", Arial, Helvetica, sans-serif; -} - -div.viewcode-block:target { - background-color: #f4debf; - border-top: 1px solid #ac9; - border-bottom: 1px solid #ac9; - margin: -1px -12px; - padding: 0 12px; -} - -div.imageBar { - font-size:x-small; - text-align: right; - padding: 10px; - margin-left: 15px; - margin-right: 10px; - margin-top: 10px; - border: 1px solid #000000; - background-color: #DDDDDD; -} - -div.tocBar { - - text-align: left; - padding: 10px; - margin-left: 15px; - margin-right: 10px; - margin-top: 10px; - border: 1px solid #000000; - background-color: #DDDDDD; -} - -div.content div.tocBar ul > li.toctree-l1 { - width: 400; - font-family: Arial, sans-serif; - color: #0C3762; - font-size: 1.2em; - font-weight: normal; - margin: 0; /** reset the margins back to 0**/ - padding: 2px 5px; - /**text-shadow: 1px 1px 0 white;**/ - background: #ddd; - font-size: 1.1em; -} - -p.caption { - font-size:x-small; - text-align: right; - background-color: #cdcdcd; -} - -div.sidebar2 { - width: 200px; - font-size: 0.75em; - line-height: 1.5em; - margin: 10px; - /* - padding-left: 10px; - padding-right: 10px; - */ -} - -div.content div.sidebar2 ul > li.toctree-l1 { - font-family: Arial, sans-serif; - color: #0C3762; - font-size: 1.2em; - font-weight: normal; - margin: 0; /** reset the margins back to 0**/ - padding: 2px 5px; - /**text-shadow: 1px 1px 0 white;**/ - background: #ddd; - font-size: 1.1em; -} - -div.content ul > li.toctree-l1 > ul { - margin: 0; -} - -div.sidebar2 h3 a { - color: #444; -} - -div.sidebar2 ul { - /** This is the selected sidebar text **/ - margin: 5px 10px; - /** - padding: 5px; - **/ - padding-left: 0px; - /**background-color: #cdcdcd;**/ -} - -div.sidebar2 li { - padding:3px; -} - -div.sidebar2 a { - color: #444; -} - -#bodycontent { - padding: 4px; -} diff --git a/docs/ociotheme/theme.conf b/docs/ociotheme/theme.conf deleted file mode 100644 index 8e18067eb4..0000000000 --- a/docs/ociotheme/theme.conf +++ /dev/null @@ -1,16 +0,0 @@ -# SPDX-License-Identifier: BSD-3-Clause -# Copyright Contributors to the OpenColorIO Project. - -[theme] -inherit = basic -stylesheet = ocio.css -pygments_style = autumn - -[options] -full_logo = false -textcolor = #333333 -headingcolor = #0c3762 -linkcolor = #dc3c01 -visitedlinkcolor = #892601 -hoverlinkcolor = #ff4500 -rightsidebar = true diff --git a/docs/quick_start/_index.rst b/docs/quick_start/_index.rst new file mode 100644 index 0000000000..9d4228cce8 --- /dev/null +++ b/docs/quick_start/_index.rst @@ -0,0 +1,19 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +Quick Start +=========== + +.. toctree:: + :caption: Quick Start + + about_docs + for_artists + for_config_authors + for_devs + for_contributors + downloads + faq + + diff --git a/docs/quick_start/about_docs.rst b/docs/quick_start/about_docs.rst new file mode 100644 index 0000000000..29ed847b74 --- /dev/null +++ b/docs/quick_start/about_docs.rst @@ -0,0 +1,15 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +About the Documentation +======================= + +Intended Audience +----------------- + +Docs Structure +-------------- + +About Versions +-------------- \ No newline at end of file diff --git a/docs/downloads.rst b/docs/quick_start/downloads.rst similarity index 100% rename from docs/downloads.rst rename to docs/quick_start/downloads.rst diff --git a/docs/FAQ.rst b/docs/quick_start/faq.rst similarity index 100% rename from docs/FAQ.rst rename to docs/quick_start/faq.rst diff --git a/docs/quick_start/for_artists.rst b/docs/quick_start/for_artists.rst new file mode 100644 index 0000000000..d80e5a3ab5 --- /dev/null +++ b/docs/quick_start/for_artists.rst @@ -0,0 +1,6 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +Quick Start for Artists +======================= \ No newline at end of file diff --git a/docs/quick_start/for_config_authors.rst b/docs/quick_start/for_config_authors.rst new file mode 100644 index 0000000000..82459172ad --- /dev/null +++ b/docs/quick_start/for_config_authors.rst @@ -0,0 +1,6 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +Quick Start for Config Authors +============================== \ No newline at end of file diff --git a/docs/quick_start/for_contributors.rst b/docs/quick_start/for_contributors.rst new file mode 100644 index 0000000000..affe69a340 --- /dev/null +++ b/docs/quick_start/for_contributors.rst @@ -0,0 +1,6 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +Quick Start for Contributors +============================ \ No newline at end of file diff --git a/docs/quick_start/for_devs.rst b/docs/quick_start/for_devs.rst new file mode 100644 index 0000000000..0ce135e887 --- /dev/null +++ b/docs/quick_start/for_devs.rst @@ -0,0 +1,6 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +Quick Start for Devs +==================== \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000000..d594080f3d --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +breathe +sphinx-tabs +recommonmark +sphinx-press-theme \ No newline at end of file diff --git a/docs/toc_redirect.rst b/docs/toc_redirect.rst new file mode 100644 index 0000000000..e8faf5a844 --- /dev/null +++ b/docs/toc_redirect.rst @@ -0,0 +1,38 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +.. toctree:: + :hidden: + + quick_start/_index + +.. toctree:: + :hidden: + + concepts/_index + +.. toctree:: + :hidden: + + tutorials/_index + +.. toctree:: + :hidden: + + guides/_index + +.. toctree:: + :hidden: + + upgrading_v2/_index + +.. toctree:: + :hidden: + + api/_index + +.. toctree:: + :hidden: + + license/_index \ No newline at end of file diff --git a/docs/configurations/images/spi-vfx/gn10_to_linear_light.jpeg b/docs/tutorials/_images/gn10_to_linear_light.jpeg similarity index 100% rename from docs/configurations/images/spi-vfx/gn10_to_linear_light.jpeg rename to docs/tutorials/_images/gn10_to_linear_light.jpeg diff --git a/docs/configurations/images/spi-vfx/gnf_to_linear_light.jpeg b/docs/tutorials/_images/gnf_to_linear_light.jpeg similarity index 100% rename from docs/configurations/images/spi-vfx/gnf_to_linear_light.jpeg rename to docs/tutorials/_images/gnf_to_linear_light.jpeg diff --git a/docs/configurations/images/spi-vfx/lg10_to_linear_light.jpeg b/docs/tutorials/_images/lg10_to_linear_light.jpeg similarity index 100% rename from docs/configurations/images/spi-vfx/lg10_to_linear_light.jpeg rename to docs/tutorials/_images/lg10_to_linear_light.jpeg diff --git a/docs/configurations/images/spi-vfx/lg8_to_vd8.jpeg b/docs/tutorials/_images/lg8_to_vd8.jpeg similarity index 100% rename from docs/configurations/images/spi-vfx/lg8_to_vd8.jpeg rename to docs/tutorials/_images/lg8_to_vd8.jpeg diff --git a/docs/configurations/images/spi-vfx/lgf_to_linear_light.jpeg b/docs/tutorials/_images/lgf_to_linear_light.jpeg similarity index 100% rename from docs/configurations/images/spi-vfx/lgf_to_linear_light.jpeg rename to docs/tutorials/_images/lgf_to_linear_light.jpeg diff --git a/docs/userguide/images/ps_icc/psicc_itworks.png b/docs/tutorials/_images/psicc_itworks.png similarity index 100% rename from docs/userguide/images/ps_icc/psicc_itworks.png rename to docs/tutorials/_images/psicc_itworks.png diff --git a/docs/userguide/images/ps_icc/psicc_open_current_profile.png b/docs/tutorials/_images/psicc_open_current_profile.png similarity index 100% rename from docs/userguide/images/ps_icc/psicc_open_current_profile.png rename to docs/tutorials/_images/psicc_open_current_profile.png diff --git a/docs/userguide/images/ps_icc/psicc_proof_setup.png b/docs/tutorials/_images/psicc_proof_setup.png similarity index 100% rename from docs/userguide/images/ps_icc/psicc_proof_setup.png rename to docs/tutorials/_images/psicc_proof_setup.png diff --git a/docs/userguide/images/ps_icc/psicc_reveal_profile.png b/docs/tutorials/_images/psicc_reveal_profile.png similarity index 100% rename from docs/userguide/images/ps_icc/psicc_reveal_profile.png rename to docs/tutorials/_images/psicc_reveal_profile.png diff --git a/docs/userguide/images/ps_icc/psicc_select_profile.png b/docs/tutorials/_images/psicc_select_profile.png similarity index 100% rename from docs/userguide/images/ps_icc/psicc_select_profile.png rename to docs/tutorials/_images/psicc_select_profile.png diff --git a/docs/tutorials/_index.rst b/docs/tutorials/_index.rst new file mode 100644 index 0000000000..0529906424 --- /dev/null +++ b/docs/tutorials/_index.rst @@ -0,0 +1,18 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +Tutorials +========= + +.. toctree:: + :caption: Tutorials + + build_config + config_examples/aces_1.0.3 + config_examples/nuke_default + config_examples/spi_anim + config_examples/spi_vfx + baking_luts + contributing + tool_overview \ No newline at end of file diff --git a/docs/userguide/baking_luts.rst b/docs/tutorials/baking_luts.rst similarity index 100% rename from docs/userguide/baking_luts.rst rename to docs/tutorials/baking_luts.rst diff --git a/docs/configurations/aces_1.0.3.rst b/docs/tutorials/config_examples/aces_1.0.3.rst similarity index 100% rename from docs/configurations/aces_1.0.3.rst rename to docs/tutorials/config_examples/aces_1.0.3.rst diff --git a/docs/configurations/nuke_default.rst b/docs/tutorials/config_examples/nuke_default.rst similarity index 100% rename from docs/configurations/nuke_default.rst rename to docs/tutorials/config_examples/nuke_default.rst diff --git a/docs/configurations/spi_anim.rst b/docs/tutorials/config_examples/spi_anim.rst similarity index 100% rename from docs/configurations/spi_anim.rst rename to docs/tutorials/config_examples/spi_anim.rst diff --git a/docs/configurations/spi_vfx.rst b/docs/tutorials/config_examples/spi_vfx.rst similarity index 100% rename from docs/configurations/spi_vfx.rst rename to docs/tutorials/config_examples/spi_vfx.rst diff --git a/docs/tutorials/contributing.rst b/docs/tutorials/contributing.rst new file mode 100644 index 0000000000..222fac7ebd --- /dev/null +++ b/docs/tutorials/contributing.rst @@ -0,0 +1,6 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +Contributing +============ \ No newline at end of file diff --git a/docs/userguide/tool_overview.rst b/docs/tutorials/tool_overview.rst similarity index 100% rename from docs/userguide/tool_overview.rst rename to docs/tutorials/tool_overview.rst diff --git a/docs/upgrading_v2/_index.rst b/docs/upgrading_v2/_index.rst new file mode 100644 index 0000000000..e65e24fda8 --- /dev/null +++ b/docs/upgrading_v2/_index.rst @@ -0,0 +1,11 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +Migrating to v2 +=============== + +.. toctree:: + :caption: Migrating to v2 + + how_to \ No newline at end of file diff --git a/docs/upgrading_v2/how_to.rst b/docs/upgrading_v2/how_to.rst new file mode 100644 index 0000000000..61ed9f14f8 --- /dev/null +++ b/docs/upgrading_v2/how_to.rst @@ -0,0 +1,6 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + +How To v2 +========= \ No newline at end of file diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst deleted file mode 100644 index dd8f997024..0000000000 --- a/docs/userguide/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. _user-guide: - -User Guide -========== - -These guides will focus on a specific task (for example, writing a basic config, or setting up per-shot LUT's). -For a "broader picture" expiation of how to use OCIO, see the :ref:`configurations` section - -.. toctree:: - :maxdepth: 2 - - tool_overview - baking_luts - contexts - looks - config_syntax diff --git a/share/cmake/macros/FindPythonPackage.cmake b/share/cmake/macros/FindPythonPackage.cmake index 1508c6c794..9b6a28e735 100644 --- a/share/cmake/macros/FindPythonPackage.cmake +++ b/share/cmake/macros/FindPythonPackage.cmake @@ -29,10 +29,19 @@ macro(find_python_package package version) if(_ARG STREQUAL "REQUIRED") set(_PKG_REQUIRED TRUE) endif() + if(_PREV_ARG STREQUAL "REQUIRES") + set(_PKG_REQUIRES ${_ARG}) + endif() + set(_PREV_ARG ${_ARG}) endforeach() + if(NOT TARGET ${package}) add_custom_target(${package}) + if(_PKG_REQUIRES) + add_dependencies(${package} ${_PKG_REQUIRES}) + unset(_PKG_REQUIRES) + endif() set(_${_PKG_UPPER}_TARGET_CREATE TRUE) endif() @@ -106,12 +115,11 @@ macro(find_python_package package version) ${package} COMMAND ${_Python_PIP} install --disable-pip-version-check - --install-option="--prefix=${_EXT_DIST_ROOT}" + --prefix=${_EXT_DIST_ROOT} -I ${package}==${version} WORKING_DIRECTORY "${CMAKE_BINARY_DIR}" ) - message(STATUS "Installing ${package}: ${_SITE_PKGS_DIR} (version ${version})") endif() endif() diff --git a/share/cmake/modules/FindExtPackages.cmake b/share/cmake/modules/FindExtPackages.cmake index 6d15342339..ee0bb28939 100644 --- a/share/cmake/modules/FindExtPackages.cmake +++ b/share/cmake/modules/FindExtPackages.cmake @@ -48,5 +48,24 @@ if(OCIO_BUILD_DOCS) # Sphinx # https://pypi.python.org/pypi/Sphinx find_package(Sphinx ${Sphinx_MIN_VERSION} REQUIRED) + + include(FindPythonPackage) + + # testresources + # https://pypi.org/project/testresources/ + find_python_package(testresources 2.0.1 REQUIRED) + + # # Sphinx-Tabs + # # https://pypi.org/project/sphinx-tabs/ + # find_python_package(sphinx-tabs 1.1.13 REQUIRED) + + # Recommonmark + # https://pypi.org/project/recommonmark/ + find_python_package(recommonmark 0.6.0 REQUIRED) + + # Sphinx Press Theme + # https://pypi.org/project/sphinx-press-theme/ + find_python_package(sphinx-press-theme 0.5.1 REQUIRES testresources REQUIRED) + endif() endif()