Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
staceyoue committed Nov 27, 2024
1 parent 355fb93 commit 34af208
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ API
Alias Python API
------------------

The Alias Python API is a Python module that provides a Pythoni interface to the Alias C++ API.
The Alias Python API is a Python module that provides a pythonic interface to the Alias C++ API.

The Alias Toolkit Framework ``tk-framework-alias`` contains the Alias Python API module itself; the Alias Engine uses the framework to get the api module. Go to the `framework documentation <https://developers.shotgridsoftware.com/tk-framework-alias/alias_python_api.html>`_ to see the Alias Python API reference documentation.

Expand Down
7 changes: 5 additions & 2 deletions docs/changes.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
What's New
####################################################

The latest version of the Alias Engine is ``v4.0.0``.
The latest version of the Alias Engine is ``v4.1.1``.

.. include:: v4.0.0.rst
.. include:: v4.1.1.rst

.. include:: v4.0.1.rst

.. include:: v4.0.0.rst

.. include:: v3.0.0.rst
Binary file added docs/images/publish-export-selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/v4.0.1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
v4.0.1
=====================

Release highlights
------------------

* Fix Alias Engine restart after Alias application exits unexpectedly
45 changes: 45 additions & 0 deletions docs/v4.1.1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
v4.1.1
=====================

Release highlights
------------------

* New publish mode "Export Selection"
* New publish option to choose publish mode


New Features
-------------

The Alias publish plugin "Publish to Flow Production Tracking" has a new Publish Mode option:

.. image:: images/publish-export-selection.png
:alt: Publish Export Selection
:width: 800px
:align: center

\

The "Default" publish mode will publish the working file as is, as it did before introducing the Publish Mode option, there is no change in behavior.

The "Export Selection" publish mode will publish only the selected objects in the Alias scene.

.. note::

The working file will not be changed. This means that the published file will differ from the corresponding working file version.

.. warning::

The "Export Selection" publish mode is not supported with Background Publishing. You must turn off the ``Background Processing`` setting in your configuration to use this publish mode. Refer to this `documentation <https://developers.shotgridsoftware.com/tk-multi-bg-publish/add_to_config.html#adding-this-app-to-your-config>`_ on how to turn off this setting.

By default, the "Default" publish mode is selected. To change the default publish mode, you can modify your configuration file ``tk-multi-publish2.yml``, for example:

.. code-block:: yaml
settings.tk-multi-publish2.alias.asset_step:
publish_plugins:
- name: Publish to Flow Production Tracking
hook: "{self}/publish_file.py:{engine}/tk-multi-publish2/basic/publish_session.py"
settings:
Publish Template: alias_asset_publish
Publish Mode: Export Selection

0 comments on commit 34af208

Please sign in to comment.