doc worflow error & docs update

pablodz · Jun 21, 2021 · 2993894 · 2993894
1 parent 88f898a
commit 2993894
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 54 deletions.
diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml
@@ -30,11 +30,10 @@ jobs:
 
       - name: commit files
         run: |
-          git pull --tags
-          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
-          git config --local user.name "github-actions[bot]"
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
           git add -A
-          git commit --allow-empty -m "pdoc updated to latest release" -a
+          git commit -m "pdoc updated to latest release" -a
 
       - name: push changes
         uses: ad-m/github-push-action@master

diff --git a/pipewire_python/__init__.py b/pipewire_python/__init__.py
@@ -1,9 +1,51 @@
 """
-Pipewire Controller:
-Python version, player and recorder via pipewire's commands
+## Description
+
+[PIPEWIRE](https://pipewire.org/) provides a low-latency, graph based processing engine
+on top of audio and video devices that can be used to
+support the use cases currently handled by both pulseaudio
+and JACK. PipeWire was designed with a powerful security model
+that makes interacting with audio and video devices from 
+containerized applications easy, with supporting Flatpak
+applications being the primary goal. Alongside Wayland and
+Flatpak we expect PipeWire to provide a core building block 
+for the future of Linux application development.
+
+[pipewire_python](https://pypi.org/project/pipewire_python/) 
+controlls `pipewire` via terminal, creating shell commands and executing them as required.
+
+🎹 There are two ways to manage the python package:
+
+1. NO_ASYNC: this way works as expected with delay time between 
+`pipewire_python` and the rest of your code.
+
+2. ASYNC: [⚠️Not yet implemented] this way works delegating the task to record or to play
+a song file in background. Works with threads.
+
+3. MULTIPROCESS: [⚠️Not yet implemented] Works with processes.
+
+
+📄 More information about `pipewire` and it's API's:
+
+- 🎵 Asyncio https://docs.python.org/3/library/asyncio-subprocess.html
+- 🎵 Pipewire APIs https://www.linuxfromscratch.org/blfs/view/cvs/multimedia/pipewire.html
+- 🎵 APIs example https://fedoraproject.org/wiki/QA:Testcase_PipeWire_PipeWire_CLI
+
+Developed with ❤️ by Pablo Diaz & Anna Absi 
+
+
+##  Install via
+```bash
+
+pip3 install pipewire_python # or pip
+```
+
+## Tutorial
+
+Tutorial [here](https://github.com/pablodz/pipewire_python/blob/main/README.py)
 """
 
-__version__ = "0.0.89"
+__version__ = "0.0.90"
 
 import sys
 

diff --git a/pipewire_python/controller.py b/pipewire_python/controller.py
@@ -1,53 +1,8 @@
 """
-## Description
-
-[PIPEWIRE](https://pipewire.org/) provides a low-latency, graph based processing engine
-on top of audio and video devices that can be used to
-support the use cases currently handled by both pulseaudio
-and JACK. PipeWire was designed with a powerful security model
-that makes interacting with audio and video devices from 
-containerized applications easy, with supporting Flatpak
-applications being the primary goal. Alongside Wayland and
-Flatpak we expect PipeWire to provide a core building block 
-for the future of Linux application development.
-
-[pipewire_python](https://pypi.org/project/pipewire_python/) 
-controlls `pipewire` via terminal, creating shell commands and executing them as required.
-
-🎹 There are two ways to manage the python package:
-
-1. NO_ASYNC: this way works as expected with delay time between 
-`pipewire_python` and the rest of your code.
-
-2. ASYNC: [⚠️Not yet implemented] this way works delegating the task to record or to play
-a song file in background. Works with threads.
-
-3. MULTIPROCESS: [⚠️Not yet implemented] Works with processes.
-
-
-📄 More information about `pipewire` and it's API's:
-
-- 🎵 Asyncio https://docs.python.org/3/library/asyncio-subprocess.html
-- 🎵 Pipewire APIs https://www.linuxfromscratch.org/blfs/view/cvs/multimedia/pipewire.html
-- 🎵 APIs example https://fedoraproject.org/wiki/QA:Testcase_PipeWire_PipeWire_CLI
-
-Developed with ❤️ by Pablo Diaz & Anna Absi 
-
-
-##  Install via
-```bash
-
-pip3 install pipewire_python # or pip
-```
-
-## Tutorial
-
-Tutorial [here](https://github.com/pablodz/pipewire_python/blob/main/README.py)
-
-<hr>
 ## Documentation
 
-In the next pages you'll see documentation of each python component.
+In the next pages you'll see documentation of each python component
+`controller.py`.
 """
 
 import warnings