!BREAKING. Change project structure

docsforadobe · Aug 21, 2020 · 8b99a9f · 8b99a9f
1 parent 1a66f72
commit 8b99a9f
Show file tree

Hide file tree

Showing 36 changed files with 89 additions and 134 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,15 @@
+{
+	// Use IntelliSense to learn about possible attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "extendscript-debug",
+			"request": "launch",
+			"name": "Ask for script name",
+			"program": "${workspaceFolder}/_testing/${command:AskForScriptName}",
+			"stopOnEntry": false
+		}
+	]
+}
diff --git a/Makefile b/Makefile
@@ -15,9 +15,9 @@ endif
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) docs
 # the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) docs
 
 .PHONY: help
 help:

diff --git a/_static/theme_overrides.css → docs/_static/theme_overrides.css b/_static/theme_overrides.css → docs/_static/theme_overrides.css
diff --git a/2 - App object/application.rst → docs/application/application.rst b/2 - App object/application.rst → docs/application/application.rst
diff --git a/18 - Collection/collection.rst → docs/collection/collection.rst b/18 - Collection/collection.rst → docs/collection/collection.rst
diff --git a/18 - Collection/componentcollection.rst → docs/collection/componentcollection.rst b/18 - Collection/componentcollection.rst → docs/collection/componentcollection.rst
diff --git a/18 - Collection/markercollection.rst → docs/collection/markercollection.rst b/18 - Collection/markercollection.rst → docs/collection/markercollection.rst
diff --git a/18 - Collection/projectcollection.rst → docs/collection/projectcollection.rst b/18 - Collection/projectcollection.rst → docs/collection/projectcollection.rst
diff --git a/18 - Collection/projectitemcollection.rst → docs/collection/projectitemcollection.rst b/18 - Collection/projectitemcollection.rst → docs/collection/projectitemcollection.rst
diff --git a/18 - Collection/sequencecollection.rst → docs/collection/sequencecollection.rst b/18 - Collection/sequencecollection.rst → docs/collection/sequencecollection.rst
diff --git a/18 - Collection/trackcollection.rst → docs/collection/trackcollection.rst b/18 - Collection/trackcollection.rst → docs/collection/trackcollection.rst
diff --git a/18 - Collection/trackitemcollection.rst → docs/collection/trackitemcollection.rst b/18 - Collection/trackitemcollection.rst → docs/collection/trackitemcollection.rst
diff --git a/conf.py → docs/conf.py b/conf.py → docs/conf.py
diff --git a/10 - Anywhere object/anywhere.rst → docs/general/anywhere.rst b/10 - Anywhere object/anywhere.rst → docs/general/anywhere.rst
diff --git a/11 - Encoder object/encoder.rst → docs/general/encoder.rst b/11 - Encoder object/encoder.rst → docs/general/encoder.rst
diff --git a/12 - Marker object/marker.rst → docs/general/marker.rst b/12 - Marker object/marker.rst → docs/general/marker.rst
diff --git a/19 - Metadata object/metadata.rst → docs/general/metadata.rst b/19 - Metadata object/metadata.rst → docs/general/metadata.rst
diff --git a/16 - Productions object/productions.rst → docs/general/production.rst b/16 - Productions object/productions.rst → docs/general/production.rst
@@ -1,9 +1,9 @@
 .. highlight:: javascript
 
-.. Productions:
+.. Production:
 
-Production
-==========
+Production object
+===================
 
 ``app.production``
 

diff --git a/3 - Project object/project.rst → docs/general/project.rst b/3 - Project object/project.rst → docs/general/project.rst
diff --git a/... ProjectManager object/projectmanager.rst → docs/general/projectmanager.rst b/... ProjectManager object/projectmanager.rst → docs/general/projectmanager.rst
diff --git a/13 - SourceMonitor object/sourcemonitor.rst → docs/general/sourcemonitor.rst b/13 - SourceMonitor object/sourcemonitor.rst → docs/general/sourcemonitor.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,67 @@
+============================================
+Welcome to the Premiere Pro Scripting Guide!
+============================================
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Introduction
+
+    introduction/index
+    introduction/changelog
+    introduction/extendscript-overview
+    introduction/how-to-execute-scripts
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Application
+
+    application/application
+
+.. toctree::
+    :maxdepth: 2
+    :caption: General
+
+    general/anywhere
+    general/encoder
+    general/marker
+    general/metadata
+    general/production
+    general/project
+    general/projectmanager
+    general/sourcemonitor
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Item
+
+    item/projectitem
+    item/trackitem
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Sequence
+
+    sequence/component
+    sequence/componentparam
+    sequence/sequence
+    sequence/track
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Other
+
+    other/audiochannelmapping
+    other/time
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Collection
+
+    collection/collection
+    collection/componentcollection
+    collection/markercollection
+    collection/projectcollection
+    collection/projectitemcollection
+    collection/sequencecollection
+    collection/trackcollection
+    collection/trackitemcollection
diff --git a/1 - Introduction/changelog.rst → docs/introduction/changelog.rst b/1 - Introduction/changelog.rst → docs/introduction/changelog.rst
diff --git a/1 - Introduction/extendscript-overview.rst → docs/introduction/extendscript-overview.rst b/1 - Introduction/extendscript-overview.rst → docs/introduction/extendscript-overview.rst
diff --git a/1 - Introduction/how-to-execute-scripts.rst → docs/introduction/how-to-execute-scripts.rst b/1 - Introduction/how-to-execute-scripts.rst → docs/introduction/how-to-execute-scripts.rst
diff --git a/1 - Introduction/index.rst → docs/introduction/index.rst b/1 - Introduction/index.rst → docs/introduction/index.rst
diff --git a/4 - ProjectItem object/projectItem.rst → docs/item/projectitem.rst b/4 - ProjectItem object/projectItem.rst → docs/item/projectitem.rst
diff --git a/7 - TrackItem object/trackitem.rst → docs/item/trackitem.rst b/7 - TrackItem object/trackitem.rst → docs/item/trackitem.rst
diff --git a/...nelMapping object/audiochannelmapping.rst → docs/other/audiochannelmapping.rst b/...nelMapping object/audiochannelmapping.rst → docs/other/audiochannelmapping.rst
diff --git a/17 - Time object/time.rst → docs/other/time.rst b/17 - Time object/time.rst → docs/other/time.rst
diff --git a/8 - Component object/component.rst → docs/sequence/component.rst b/8 - Component object/component.rst → docs/sequence/component.rst
diff --git a/...onent Parameter object/componentparam.rst → docs/sequence/componentparam.rst b/...onent Parameter object/componentparam.rst → docs/sequence/componentparam.rst
diff --git a/5 - Sequence object/sequence.rst → docs/sequence/sequence.rst b/5 - Sequence object/sequence.rst → docs/sequence/sequence.rst
diff --git a/6 - Track object/track.rst → docs/sequence/track.rst b/6 - Track object/track.rst → docs/sequence/track.rst
diff --git a/index.rst b/index.rst
diff --git a/make.bat b/make.bat
@@ -6,8 +6,8 @@ if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
 set BUILDDIR=_build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
-set I18NSPHINXOPTS=%SPHINXOPTS% .
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% docs
+set I18NSPHINXOPTS=%SPHINXOPTS% docs
 if NOT "%PAPER%" == "" (
 	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
 	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%