Permalink
Browse files

Wiki removal (#340)

* Replacing links to the wiki in favor of readthedocs.
  • Loading branch information...
jminor committed Oct 10, 2018
1 parent 9b6aace commit 7e82ebf1a63819aba4e08c5cfcb26be384b86688
View
@@ -1,2 +1,2 @@
Thank you for your interest in contributing to OpenTimelineIO!
We ask that potential contributors review our guidelines on [contributing](https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/Contributing) before submitting a pull request.
We ask that potential contributors review our guidelines on [contributing](https://opentimelineio.readthedocs.io/en/latest/tutorials/contributing.html) before submitting a pull request.
View
@@ -78,7 +78,7 @@ https://github.com/PixarAnimationStudios/OpenTimelineIO/tree/master/tests
OTIO includes a viewer program as well:
![OTIO View Screenshot](https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/images/otioview.png)
![OTIO View Screenshot](docs/_static/otioview.png)
Developing
-------
View
Binary file not shown.
@@ -1,6 +1,6 @@
# Quickstart
This wiki is for users who wish to get started using the "OTIOView" application to inspect the contents of editorial files.
This is for users who wish to get started using the "OTIOView" application to inspect the contents of editorial timelines.
## Install Prerequisites
@@ -18,7 +18,7 @@ You probably want the prebuilt binary for your platform. PySide2 generally incl
## Configure Environment Variables for extra adapters
By default, when you install OTIO you will only get the "Core" adapters, which include CMX EDL, Final Cut Pro 7 XML, and the built in JSON format. In order to get access to the "contrib" adapters (which includes the maya sequencer, rv and others) you'll need to set some environment variables. If you need support for these formats, please consult the
<a href="https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/Adapters" target="_blank"> Adapters wiki page for details</a>
<a href="adapters.html" target="_blank"> Adapters documentation page for details</a>
## Run OTIOView
@@ -2,7 +2,7 @@
The current python implementation of OTIO has been super helpful for defining the library and getting studio needs settled, but in order to integrate the library into vendor tools, a C/C++ implementation is required. We don't want to give up the Python API, however, so the plan is to port the library to C/C++ with a Python wrapper that implements an interface to the library as it currently stands; existing Python code shouldn't notice the switch. We can use the existing unit tests to vet the implementation and make sure that it matches the Python API.
There are several options for how to wrap C/C++ in Python, the intent of this wiki is to discuss the options we see and their pros/cons.
There are several options for how to wrap C/C++ in Python, the intent of this document is to discuss the options we see and their pros/cons.
## Python C-API
@@ -36,7 +36,7 @@ Finally, to specify this linker as the default media linker, set `OTIO_DEFAULT_M
setenv OTIO_DEFAULT_MEDIA_LINKER "awesome_studios_media_linker"
To package and share your media linker, follow [these instructions](https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/How-to-Write-an-OpenTimelineIO-Adapter#packaging-and-sharing-custom-adapters).
To package and share your media linker, follow [these instructions](write-an-adapter.html#packaging-and-sharing-custom-adapters).
## Writing a Media Linker
@@ -21,7 +21,7 @@ To create a new contrib OTIO Adapter, you need to create a file `myadapter.py` i
### Custom Adapters
Alternately, if you are creating a site specific adapter that you do _not_ intend to share with the community, you can create your `myadapter.py` file anywhere. In this case, you must create a `mysite.plugin_manifest.json` (with an entry like the below example that points at `myadapter.py`) and then put the path to your `mysite.plugin_manifest.json` on your `$OTIO_OTIO_PLUGIN_MANIFEST_PATH` environment variable, which is ":" separated.
Alternately, if you are creating a site specific adapter that you do _not_ intend to share with the community, you can create your `myadapter.py` file anywhere. In this case, you must create a `mysite.plugin_manifest.json` (with an entry like the below example that points at `myadapter.py`) and then put the path to your `mysite.plugin_manifest.json` on your `$OTIO_PLUGIN_MANIFEST_PATH` environment variable, which is ":" separated.
For example, to register `myadapter.py` that supports files with a `.myext` file extension:
```json
@@ -25,7 +25,7 @@
"""Implementation of the OTIO internal `Adapter` system.
For information on writing adapters, please consult:
https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/How-to-Write-an-OpenTimelineIO-Adapter # noqa
https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an-adapter.html# # noqa
"""
from .. import (
@@ -53,7 +53,7 @@ class Adapter(plugins.PythonPlugin):
for OTIO.
For more information:
https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/How-to-Write-an-OpenTimelineIO-Adapter # noqa
https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an-adapter.html# # noqa
"""
_serializable_label = "Adapter.1"
@@ -26,7 +26,7 @@
# Note: this adapter is not an ideal model for new adapters, but it works.
# If you want to write your own adapter, please see:
# https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/How-to-Write-an-OpenTimelineIO-Adapter
# https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an-adapter.html#
# TODO: Flesh out Attribute Handler
# TODO: Add line numbers to errors and warnings
@@ -57,7 +57,7 @@ class Manifest(core.SerializableObject):
collection of adapters and allows finding specific adapters by suffix
For writing your own adapters, consult:
https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/How-to-Write-an-OpenTimelineIO-Adapter
https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an-adapter.html#
"""
_serializable_label = "PluginManifest.1"
View
@@ -129,7 +129,7 @@ def test_otio():
'Source':
'https://github.com/PixarAnimationStudios/OpenTimelineIO',
'Documentation':
'https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki',
'https://opentimelineio.readthedocs.io/',
'Issues':
'https://github.com/PixarAnimationStudios/OpenTimelineIO/issues',
},
@@ -24,7 +24,7 @@
"""This file is here to support the test_adapter_plugin unittest.
If you want to learn how to write your own adapter plugin, please read:
https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/How-to-Write-an-OpenTimelineIO-Adapter
https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an-adapter.html
"""
import opentimelineio as otio

0 comments on commit 7e82ebf

Please sign in to comment.