From 24e8321b8ce8b4cd2bca4debb8c8352b2cefa1ab Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Tue, 26 Sep 2023 10:01:17 +0200 Subject: [PATCH 01/42] Delete scraibe/.pyannotetoken --- scraibe/.pyannotetoken | 1 - 1 file changed, 1 deletion(-) delete mode 100644 scraibe/.pyannotetoken diff --git a/scraibe/.pyannotetoken b/scraibe/.pyannotetoken deleted file mode 100644 index 42ba269..0000000 --- a/scraibe/.pyannotetoken +++ /dev/null @@ -1 +0,0 @@ -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 \ No newline at end of file From 11da0dfa31cfe154e52fc583a916ea12c20dcc1c Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 12:07:17 +0200 Subject: [PATCH 02/42] add sphinx documentation workflow --- .github/workflows/documentation.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..4bae9db --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,27 @@ +name: documentation + +on: [push, pull_request, workflow_dispatch] + +permissions: + contents: write + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v3 + - name: Install dependencies + run: | + pip install sphinx sphinx_rtd_theme myst_parser + - name: Sphinx build + run: | + sphinx-build doc _build + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} + with: + publish_branch: sphinx_action + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: _build/ + force_orphan: true \ No newline at end of file From a3f1e413bdf0fdea2bef2e6a9743201f341e012f Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 12:13:38 +0200 Subject: [PATCH 03/42] change source and dest --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 4bae9db..d120ca8 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -16,7 +16,7 @@ jobs: pip install sphinx sphinx_rtd_theme myst_parser - name: Sphinx build run: | - sphinx-build doc _build + sphinx-build -M html scraibe docs - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} From 6a07f660d25028d062f505e378e1fb7a495ec2d6 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 12:19:45 +0200 Subject: [PATCH 04/42] changed version of checkout --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index d120ca8..98cfa19 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -9,7 +9,7 @@ jobs: docs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: actions/setup-python@v3 - name: Install dependencies run: | From ceb1172e139a9c7a4832d5e223c3ff212e272ae3 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 12:21:13 +0200 Subject: [PATCH 05/42] changed source folder --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 98cfa19..7f2682b 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -16,7 +16,7 @@ jobs: pip install sphinx sphinx_rtd_theme myst_parser - name: Sphinx build run: | - sphinx-build -M html scraibe docs + sphinx-build -M html . docs - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} From 98d26406a2a0f4f4032b78ac522991add185314a Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 15:15:03 +0200 Subject: [PATCH 06/42] changed path to pictures --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dd6ef61..f187d65 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ During post-diarization, each audio segment is processed by the OpenAI `Whisper` The following graphic illustrates the whole pipeline: -![Pipeline](Pictures/pipeline.png#gh-dark-mode-only) -![Pipeline](Pictures/pipeline_light.png#gh-light-mode-only) +![Pipeline](./Pictures/pipeline.png#gh-dark-mode-only) +![Pipeline](./Pictures/pipeline_light.png#gh-light-mode-only) ## Install `ScrAIbe` : @@ -123,7 +123,7 @@ The default address is: http://127.0.0.1:7860 or http://0.0.0.0:7860 After the app is running, you can upload your audio file and select the desired options. An example is shown below: -![Gradio App](Pictures/gradio_app.png) +![Gradio App](./Pictures//gradio_app.png) ### Running a Docker container @@ -199,6 +199,6 @@ ScrAIbe is licensed under GNU General Public License. Special thanks go to the KIDA project and the BMEL (Bundesministerium für Ernährung und Landwirtschaft), especially to the AI Consultancy Team. -![KIDA](Pictures/kida_dark.png#gh-dark-mode-only)   ![BMEL](Pictures/BMEL_dark.png#gh-dark-mode-only)      ![DBFZ](Pictures/DBFZ_dark.png#gh-dark-mode-only)       ![MRI](Pictures/MRI.png#gh-dark-mode-only) +![KIDA](./Pictures/kida_dark.png#gh-dark-mode-only)   ![BMEL](./Pictures/BMEL_dark.png#gh-dark-mode-only)      ![DBFZ](./Pictures/DBFZ_dark.png#gh-dark-mode-only)       ![MRI](./Pictures/MRI.png#gh-dark-mode-only) -![KIDA](Pictures/kida.png#gh-light-mode-only)   ![BMEL](Pictures/BMEL.jpg#gh-light-mode-only)      ![DBFZ](Pictures/DBFZ.png#gh-light-mode-only)       ![MRI](Pictures/MRI.png#gh-light-mode-only) +![KIDA](./Pictures/kida.png#gh-light-mode-only)   ![BMEL](./Pictures/BMEL.jpg#gh-light-mode-only)      ![DBFZ](./Pictures/DBFZ.png#gh-light-mode-only)       ![MRI](./Pictures/MRI.png#gh-light-mode-only) From 68e4aaa82fb9431a0dbf64da182538464887ad95 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 15:23:20 +0200 Subject: [PATCH 07/42] added for sphinx support --- source/conf.py | 86 ++++++++++++++++++++++++++++++++++++++++++++++ source/index.rst | 19 ++++++++++ source/modules.rst | 7 ++++ 3 files changed, 112 insertions(+) create mode 100644 source/conf.py create mode 100644 source/index.rst create mode 100644 source/modules.rst diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..37d26d1 --- /dev/null +++ b/source/conf.py @@ -0,0 +1,86 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +import shutil + +sys.path.insert(0, os.path.abspath('../')) + + +# -- Project information ----------------------------------------------------- + +project = 'ScrAIbe: Streamlined Conversation Recording with Automated Intelligence Based Environment' +copyright = '2023, Jacob Schmieder' +author = 'Jacob Schmieder' + +# The full version, including alpha/beta/rc tags +release = '0.1.1' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages', + 'sphinx.ext.napoleon', + 'myst_parser'] + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_init_with_doc = True +napoleon_include_private_with_doc = True +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + +# Add source file parsers +source_suffix = { + '.rst': 'restructuredtext', + '.txt': 'markdown', + '.md': 'markdown', +} + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..df0525a --- /dev/null +++ b/source/index.rst @@ -0,0 +1,19 @@ +Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligence Based Environment's documentation! +===================================================================================================================== + +.. automodule:: scraibe + :members: +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + ../README.md + modules + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/source/modules.rst b/source/modules.rst new file mode 100644 index 0000000..5876262 --- /dev/null +++ b/source/modules.rst @@ -0,0 +1,7 @@ +scraibe +======= + +.. toctree:: + :maxdepth: 4 + + scraibe From 9fcc20bc96b68254824ddba4116b18706562b5b3 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 15:24:45 +0200 Subject: [PATCH 08/42] changed ci to support sphinx autodoc --- .github/workflows/documentation.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 7f2682b..860500b 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -16,7 +16,9 @@ jobs: pip install sphinx sphinx_rtd_theme myst_parser - name: Sphinx build run: | - sphinx-build -M html . docs + sphinx-apidoc -o source scraibe/ + sphinx-build source docs + - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} From 92ff7af76677fc6a859a6ad4d471796d8084d558 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 15:29:18 +0200 Subject: [PATCH 09/42] test ci --- .github/workflows/documentation.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 860500b..94327f6 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -18,12 +18,12 @@ jobs: run: | sphinx-apidoc -o source scraibe/ sphinx-build source docs - + - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} with: - publish_branch: sphinx_action + publish_branch: est_shinx_actions github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: _build/ force_orphan: true \ No newline at end of file From 5a07825db43856cbe231800f5da88465fbb918a9 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 15:30:13 +0200 Subject: [PATCH 10/42] test2 --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 94327f6..6c55dd2 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -23,7 +23,7 @@ jobs: uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} with: - publish_branch: est_shinx_actions + publish_branch: test_sphinx_actions github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: _build/ force_orphan: true \ No newline at end of file From 4eef06fc83994d90d7a4d907f1349329ff0acc91 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 15:34:03 +0200 Subject: [PATCH 11/42] changed branch name --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 6c55dd2..08c4855 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -23,7 +23,7 @@ jobs: uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} with: - publish_branch: test_sphinx_actions + publish_branch: gh-pages github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: _build/ force_orphan: true \ No newline at end of file From d2bc0928e070269470896f1e20eae826689b4cdb Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 15:58:31 +0200 Subject: [PATCH 12/42] changed var name --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 08c4855..9aedbb0 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -24,6 +24,6 @@ jobs: if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} with: publish_branch: gh-pages - github_token: ${{ secrets.GITHUB_TOKEN }} + github_token: ${{ secrets.TOKEN_GH }} publish_dir: _build/ force_orphan: true \ No newline at end of file From 14be0a2456793ae0150d1b6db243482e8bdb5412 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 16:04:17 +0200 Subject: [PATCH 13/42] add make html --- .github/workflows/documentation.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 9aedbb0..25e3085 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -17,8 +17,8 @@ jobs: - name: Sphinx build run: | sphinx-apidoc -o source scraibe/ - sphinx-build source docs - + sphinx-build source docs + make html - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} From cec01417ca241e2df646b7a80a6c74630983c867 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 16:05:59 +0200 Subject: [PATCH 14/42] change publish dir --- .github/workflows/documentation.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 25e3085..40c7c68 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -18,12 +18,11 @@ jobs: run: | sphinx-apidoc -o source scraibe/ sphinx-build source docs - make html - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} with: publish_branch: gh-pages github_token: ${{ secrets.TOKEN_GH }} - publish_dir: _build/ + publish_dir: ./docs force_orphan: true \ No newline at end of file From 7aafc4f48b102ed85193de2dcd5b950232949669 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Fri, 6 Oct 2023 16:22:45 +0200 Subject: [PATCH 15/42] added documentation page --- .github/workflows/documentation.yml | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 40c7c68..9455895 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -17,7 +17,7 @@ jobs: - name: Sphinx build run: | sphinx-apidoc -o source scraibe/ - sphinx-build source docs + sphinx-build -M html source docs - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} diff --git a/README.md b/README.md index f187d65..8ecf2b4 100644 --- a/README.md +++ b/README.md @@ -163,7 +163,7 @@ For further guidance, check: https://blog.roboflow.com/use-the-gpu-in-docker/ ## Documentation -For further insights, check the [documentation page](). +For further insights, check the [documentation page](https://jschmie.github.io/ScrAIbe/). ## Contributions From ebefc27cad3839e147aa69dfb1593f9eae7b5a23 Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Sat, 7 Oct 2023 18:43:37 +0200 Subject: [PATCH 16/42] changed path to docs/html --- .github/workflows/documentation.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 9455895..bb74e46 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -24,5 +24,5 @@ jobs: with: publish_branch: gh-pages github_token: ${{ secrets.TOKEN_GH }} - publish_dir: ./docs - force_orphan: true \ No newline at end of file + publish_dir: ./docs/html + force_orphan: true From 10e8c3137e48785136d58fc14f020664a86252d3 Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Sat, 7 Oct 2023 18:51:53 +0200 Subject: [PATCH 17/42] Update documentation.yml --- .github/workflows/documentation.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index bb74e46..8fb6de5 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -18,6 +18,7 @@ jobs: run: | sphinx-apidoc -o source scraibe/ sphinx-build -M html source docs + make html - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }} From e9510394aa247516397313df7cfd8310562f2938 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Sun, 8 Oct 2023 19:10:46 +0200 Subject: [PATCH 18/42] added make file to make sphinx work --- Makefile | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) From 44644de687585f0106deb565f2edcf6e4ebf3af5 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Sun, 8 Oct 2023 19:16:49 +0200 Subject: [PATCH 19/42] added torch dep --- .github/workflows/documentation.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 8fb6de5..1f3f3c8 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -14,6 +14,7 @@ jobs: - name: Install dependencies run: | pip install sphinx sphinx_rtd_theme myst_parser + pip install torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0 --extra-index-url https://download.pytorch.org/whl/cpu - name: Sphinx build run: | sphinx-apidoc -o source scraibe/ From 9bdd9584a97734db88b62f3d961140e26933c256 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Sun, 8 Oct 2023 19:18:33 +0200 Subject: [PATCH 20/42] added python version --- .github/workflows/documentation.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 1f3f3c8..35d97f3 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -11,6 +11,8 @@ jobs: steps: - uses: actions/checkout@v4 - uses: actions/setup-python@v3 + with: + python-version: 3.8 - name: Install dependencies run: | pip install sphinx sphinx_rtd_theme myst_parser From 03cc6c9f3aba6be09e977a511cec5c2390996dee Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Sun, 8 Oct 2023 19:19:59 +0200 Subject: [PATCH 21/42] added other requirements --- .github/workflows/documentation.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 35d97f3..91a1f63 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -16,6 +16,7 @@ jobs: - name: Install dependencies run: | pip install sphinx sphinx_rtd_theme myst_parser + pip install -r requirements.txt pip install torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0 --extra-index-url https://download.pytorch.org/whl/cpu - name: Sphinx build run: | From be8bae3da8433cb697c295b66a6e9e41d4c216cf Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Sun, 8 Oct 2023 19:27:40 +0200 Subject: [PATCH 22/42] changed sphinx error due to bug --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 91a1f63..8418117 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -15,7 +15,7 @@ jobs: python-version: 3.8 - name: Install dependencies run: | - pip install sphinx sphinx_rtd_theme myst_parser + pip install sphinx~=7.2 sphinx_rtd_theme~=1.3.0 myst_parser~=2.0.0 pip install -r requirements.txt pip install torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0 --extra-index-url https://download.pytorch.org/whl/cpu - name: Sphinx build From 39c2ca358cec199efb18e36a992bde2c9b0981b2 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Sun, 8 Oct 2023 19:29:24 +0200 Subject: [PATCH 23/42] changed python version and tryed to update pip --- .github/workflows/documentation.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 8418117..925876c 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -12,9 +12,10 @@ jobs: - uses: actions/checkout@v4 - uses: actions/setup-python@v3 with: - python-version: 3.8 + python-version: 3.9 - name: Install dependencies run: | + pip install --upgrade pip pip install sphinx~=7.2 sphinx_rtd_theme~=1.3.0 myst_parser~=2.0.0 pip install -r requirements.txt pip install torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0 --extra-index-url https://download.pytorch.org/whl/cpu From 4d8012ae01fe78deacfc30b61092b350fb4497d4 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Sun, 8 Oct 2023 19:42:52 +0200 Subject: [PATCH 24/42] removed dep from config.py --- source/conf.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/conf.py b/source/conf.py index 37d26d1..ba51ab3 100644 --- a/source/conf.py +++ b/source/conf.py @@ -12,8 +12,6 @@ # import os import sys -import shutil - sys.path.insert(0, os.path.abspath('../')) From 23747b31e6556e132e0c13bed2934a161add0ef6 Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Fri, 13 Oct 2023 08:57:48 +0200 Subject: [PATCH 25/42] Update index.rst --- source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.rst b/source/index.rst index df0525a..0ba34d6 100644 --- a/source/index.rst +++ b/source/index.rst @@ -7,7 +7,7 @@ Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligen :maxdepth: 2 :caption: Contents: - ../README.md + . ./README.md modules From f6e9f27d1288aa65da629e98bde368a672716b0f Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Fri, 13 Oct 2023 09:44:26 +0200 Subject: [PATCH 26/42] Update index.rst --- source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.rst b/source/index.rst index 0ba34d6..da1adf3 100644 --- a/source/index.rst +++ b/source/index.rst @@ -7,7 +7,7 @@ Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligen :maxdepth: 2 :caption: Contents: - . ./README.md + modules From 7ba3d10e0b363392f51cba6e2fb03356ab2d2ead Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Sun, 15 Oct 2023 17:53:13 +0200 Subject: [PATCH 27/42] Update documentation.yml Changed pip install from myst_parser to myst-parser --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 925876c..5a2d741 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -16,7 +16,7 @@ jobs: - name: Install dependencies run: | pip install --upgrade pip - pip install sphinx~=7.2 sphinx_rtd_theme~=1.3.0 myst_parser~=2.0.0 + pip install sphinx sphinx_rtd_theme myst-parser pip install -r requirements.txt pip install torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0 --extra-index-url https://download.pytorch.org/whl/cpu - name: Sphinx build From 9ce7924a9a1d8c3ff2df7bfd75c02676631ae3ba Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Sun, 15 Oct 2023 18:02:09 +0200 Subject: [PATCH 28/42] try to resolve pip error --- .github/workflows/documentation.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 5a2d741..df1eed1 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -16,7 +16,9 @@ jobs: - name: Install dependencies run: | pip install --upgrade pip - pip install sphinx sphinx_rtd_theme myst-parser + pip install --upgrade sphinx sphinx_rtd_theme myst-parser + pip install --upgrade markdown-it-py[plugins] + pip install --upgrade mdit-py-plugins pip install -r requirements.txt pip install torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0 --extra-index-url https://download.pytorch.org/whl/cpu - name: Sphinx build From 4f6cc87ca4a29426bdee7e76cb84c9d6c61d5393 Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Sun, 15 Oct 2023 18:05:45 +0200 Subject: [PATCH 29/42] Update documentation.yml --- .github/workflows/documentation.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index df1eed1..ef21696 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -16,11 +16,12 @@ jobs: - name: Install dependencies run: | pip install --upgrade pip + pip install -r requirements.txt + pip install torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0 --extra-index-url https://download.pytorch.org/whl/cpu pip install --upgrade sphinx sphinx_rtd_theme myst-parser pip install --upgrade markdown-it-py[plugins] pip install --upgrade mdit-py-plugins - pip install -r requirements.txt - pip install torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0 --extra-index-url https://download.pytorch.org/whl/cpu + - name: Sphinx build run: | sphinx-apidoc -o source scraibe/ From 87d356cb33777bdbeecbe9fa1ce627c5f6d16130 Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Sun, 15 Oct 2023 18:14:45 +0200 Subject: [PATCH 30/42] avoid cuda --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index ef21696..2e0ec4e 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -17,7 +17,7 @@ jobs: run: | pip install --upgrade pip pip install -r requirements.txt - pip install torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0 --extra-index-url https://download.pytorch.org/whl/cpu + pip install --upgrade --force-reinstall torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0+cpu --extra-index-url https://download.pytorch.org/whl/cpu pip install --upgrade sphinx sphinx_rtd_theme myst-parser pip install --upgrade markdown-it-py[plugins] pip install --upgrade mdit-py-plugins From 6bd3d4c758ef1600f33267e593af561ebca4b13a Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Sun, 15 Oct 2023 18:20:09 +0200 Subject: [PATCH 31/42] added libsndfile1-dev --- .github/workflows/documentation.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 2e0ec4e..15266ba 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -15,6 +15,7 @@ jobs: python-version: 3.9 - name: Install dependencies run: | + apt-get install libsndfile1-dev pip install --upgrade pip pip install -r requirements.txt pip install --upgrade --force-reinstall torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0+cpu --extra-index-url https://download.pytorch.org/whl/cpu From 5d6adc92d4271a5a26b7e6b62bf45a23ba21c28b Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Sun, 15 Oct 2023 18:24:31 +0200 Subject: [PATCH 32/42] added sudo idk if it will work --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 15266ba..9844332 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -15,7 +15,7 @@ jobs: python-version: 3.9 - name: Install dependencies run: | - apt-get install libsndfile1-dev + sudo apt-get install libsndfile1-dev pip install --upgrade pip pip install -r requirements.txt pip install --upgrade --force-reinstall torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0+cpu --extra-index-url https://download.pytorch.org/whl/cpu From 7076160f493fb6c6fb4a40491fc2fc7dfe84002a Mon Sep 17 00:00:00 2001 From: Jacob Schmieder Date: Sun, 15 Oct 2023 18:34:04 +0200 Subject: [PATCH 33/42] added numpy dep --- .github/workflows/documentation.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 9844332..d7be839 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -19,6 +19,7 @@ jobs: pip install --upgrade pip pip install -r requirements.txt pip install --upgrade --force-reinstall torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0+cpu --extra-index-url https://download.pytorch.org/whl/cpu + pip install numpy==1.25 pip install --upgrade sphinx sphinx_rtd_theme myst-parser pip install --upgrade markdown-it-py[plugins] pip install --upgrade mdit-py-plugins From cc6223c82992d3348942001818f1cb40df6715d9 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Mon, 16 Oct 2023 10:54:24 +0200 Subject: [PATCH 34/42] added readme back in --- source/index.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/source/index.rst b/source/index.rst index da1adf3..8c8c0ba 100644 --- a/source/index.rst +++ b/source/index.rst @@ -1,16 +1,18 @@ Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligence Based Environment's documentation! ===================================================================================================================== +Readme File +=========== + +../README.md + + .. automodule:: scraibe :members: .. toctree:: :maxdepth: 2 :caption: Contents: - - modules - - Indices and tables ================== From 53bee386b54354a0cae0afb07ca26748321e93b1 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Mon, 16 Oct 2023 13:22:27 +0200 Subject: [PATCH 35/42] changed Readme position --- source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.rst b/source/index.rst index 8c8c0ba..e2e71fe 100644 --- a/source/index.rst +++ b/source/index.rst @@ -4,7 +4,7 @@ Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligen Readme File =========== -../README.md + ../README.md .. automodule:: scraibe From ff25545c20b6033edc2e9192f19223de3bcba636 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Mon, 16 Oct 2023 13:36:43 +0200 Subject: [PATCH 36/42] try to include readme.md --- source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.rst b/source/index.rst index e2e71fe..cebfd43 100644 --- a/source/index.rst +++ b/source/index.rst @@ -4,7 +4,7 @@ Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligen Readme File =========== - ../README.md +.. mdinclude::../README.md .. automodule:: scraibe From 7c26f679ac8539115fc109705f103fb078e49e5b Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Mon, 16 Oct 2023 14:00:11 +0200 Subject: [PATCH 37/42] changed to include --- source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.rst b/source/index.rst index cebfd43..93164b5 100644 --- a/source/index.rst +++ b/source/index.rst @@ -4,7 +4,7 @@ Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligen Readme File =========== -.. mdinclude::../README.md +.. include:: ../README.md .. automodule:: scraibe From 19ada49f46bebec71815035d8e5749abb3f496f6 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Mon, 16 Oct 2023 14:29:33 +0200 Subject: [PATCH 38/42] changed position of Readme --- source/index.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/source/index.rst b/source/index.rst index 93164b5..6191c6d 100644 --- a/source/index.rst +++ b/source/index.rst @@ -4,7 +4,6 @@ Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligen Readme File =========== -.. include:: ../README.md .. automodule:: scraibe @@ -13,6 +12,11 @@ Readme File :maxdepth: 2 :caption: Contents: + .. include:: ../README.md + :parser: myst_parser.sphinx_ + + modules + Indices and tables ================== From 87da03d74e5e44d91adaa77f69a3e35ece9be3e5 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Mon, 16 Oct 2023 14:36:56 +0200 Subject: [PATCH 39/42] moved parser --- source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.rst b/source/index.rst index 6191c6d..eaecbd1 100644 --- a/source/index.rst +++ b/source/index.rst @@ -13,7 +13,7 @@ Readme File :caption: Contents: .. include:: ../README.md - :parser: myst_parser.sphinx_ + :parser: myst_parser.sphinx_ modules From 3647753a509f655ee1df2c9eabd6094de5a97a23 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Mon, 16 Oct 2023 16:20:56 +0200 Subject: [PATCH 40/42] fixed Readme --- .github/workflows/documentation.yml | 3 +++ source/index.rst | 13 +++++-------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index d7be839..15a4784 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -26,6 +26,9 @@ jobs: - name: Sphinx build run: | + cp README.md ./source/README.md + cp LICENSE ./source/LICENSE + cp Pictures ./source/Pictures sphinx-apidoc -o source scraibe/ sphinx-build -M html source docs make html diff --git a/source/index.rst b/source/index.rst index eaecbd1..1eaceef 100644 --- a/source/index.rst +++ b/source/index.rst @@ -1,22 +1,19 @@ Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligence Based Environment's documentation! ===================================================================================================================== -Readme File -=========== - - - .. automodule:: scraibe - :members: + :members: + .. toctree:: :maxdepth: 2 :caption: Contents: - .. include:: ../README.md - :parser: myst_parser.sphinx_ + ../README.md modules + ../LICENSE + Indices and tables ================== From c27fb6ff05d058b69b39c8cd06322fef6a58ae78 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Mon, 16 Oct 2023 16:24:54 +0200 Subject: [PATCH 41/42] fixed recursive cp for pictures --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 15a4784..1e52fb0 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -28,7 +28,7 @@ jobs: run: | cp README.md ./source/README.md cp LICENSE ./source/LICENSE - cp Pictures ./source/Pictures + cp -r Pictures ./source/Pictures sphinx-apidoc -o source scraibe/ sphinx-build -M html source docs make html From 96f7dce6a1584cb6f8ab7b9b73d31f61ee66332b Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Mon, 16 Oct 2023 16:34:02 +0200 Subject: [PATCH 42/42] fixed LICENSE --- README.md | 2 +- source/index.rst | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 8ecf2b4..257a8ab 100644 --- a/README.md +++ b/README.md @@ -193,7 +193,7 @@ For queries contact [Jacob Schmieder](Jacob.Schmieder@dbfz.de) ## License -ScrAIbe is licensed under GNU General Public License. +ScrAIbe is licensed under [GNU General Public License](LICENSE). ## Acknowledgments diff --git a/source/index.rst b/source/index.rst index 1eaceef..9ac31fa 100644 --- a/source/index.rst +++ b/source/index.rst @@ -12,7 +12,6 @@ Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligen modules - ../LICENSE Indices and tables ==================