Added documentation for builders

iluvcapra · Jul 21, 2023 · c2b2cc7 · c2b2cc7
1 parent 2e64947
commit c2b2cc7
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 6 deletions.
diff --git a/docs/source/builders.rst b/docs/source/builders.rst
@@ -0,0 +1,24 @@
+Builders
+========
+
+.. currentmodule:: ptsl
+
+.. autoclass:: ptsl.builders.create_session_builder.CreateSessionBuilder
+ :members:
+ :undoc-members:
+
+.. autoclass:: ptsl.builders.create_session_builder.CreateSessionFromTemplateBuilder
+ :members:
+ :undoc-members:
+
+.. autoclass:: ptsl.builders.create_session_builder.CreateSessionFromAAFBuilder
+ :members:
+ :undoc-members:
+
+.. autoclass:: ptsl.builders.export_text_builder.ExportSessionTextBuilder
+ :members:
+ :undoc-members:
+
+.. autoclass:: ptsl.builders.import_builder.ImportSessionDataBuilder
+ :undoc-members:
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,6 +13,7 @@ Welcome to py-ptsl's documentation!
  :caption: Notes:
 
  engine
+ builders
  types
  utils
  implementation

diff --git a/docs/source/utils.rst b/docs/source/utils.rst
@@ -17,11 +17,9 @@ Working With Sample Rates and Pull Rates
 
 .. autofunction:: ptsl.util.sample_rate_info
 
-.. autofunction:: ptsl.util.pull_rate_info
+.. autofunction:: ptsl.util.sample_rate_enum
 
+.. autofunction:: ptsl.util.pull_rate_info
 
-Working with Paths
-------------------
 
-.. autofunction:: ptsl.util.macos_to_patform_path 
-
+
diff --git a/ptsl/engine.py b/ptsl/engine.py
@@ -116,7 +116,18 @@ def create_session(self,
  name: str,
  path: str) -> CreateSessionBuilder:
  """
- Create a new Pro Tools session.
+ Create a new Pro Tools session. Returns a 
+ :class:`~ptsl.builders.create_session_builder.CreateSessionBuilder` object used to 
+ customize the creation request.
+
+ .. sourcecode:: python
+ :caption: Creating a session with a builder
+
+ b = engine.create_session("My Session", "/Path/to/Session")
+ b.wave_format()
+ b.sample_rate(96000)
+ b.bit_depth(32)
+ b.create() # Session is created
 
  :param str name: Session Name
  :param str path: Path to the new session