From 0a6006c06d6a09e5a8caeff1788b97aa6b43a6d2 Mon Sep 17 00:00:00 2001 From: Dominik Schiller Date: Tue, 15 Oct 2024 13:59:30 +0200 Subject: [PATCH] Workflow test branch (#5) * Update README.md * Rename Nova-Server to DISCOVER in doc strings * Update execution_handler.py * Update index.rst * Squashed commit of the following: commit e015df5c1defd8b39d4cd9b09b56dd893f4f0b8c Author: dominik <907555+shelm@users.noreply.github.com> Date: Wed Oct 9 13:20:42 2024 +0200 Fix naming bug for tmp dir variable commit eac00df310fa30af574f27a1bbfbf39de72f41dc Merge: 1ff233a b8593ee Author: Dominik Schiller Date: Wed Oct 9 13:11:57 2024 +0200 Merge pull request #2 from hcmlab/workflow_test_branch Update Documentation Workflow commit 1ff233a525b7e440dcfb23434f4f42818320c4df Author: Dominik Schiller Date: Wed Oct 9 13:06:02 2024 +0200 Update build-doc.yml commit 12900e4409031f4e6284682ef709403e82b3d441 Author: Dominik Schiller Date: Wed Oct 9 13:04:14 2024 +0200 Update build-doc.yml commit d77cdd696288f45a9ce7156eed7a40f97ddf3046 Author: Dominik Schiller Date: Wed Oct 9 12:53:59 2024 +0200 Update build-doc.yml commit ad66db072c375c1599f250e99ba5ce68bccb52c7 Author: Dominik Schiller Date: Wed Oct 9 12:51:22 2024 +0200 Update build-doc.yml * Update build-doc.yml * Update build-doc.yml * Remove docbuild folder * Update build-doc.yml * Update build-doc.yml * Squashed commit of the following: commit fb622758fe4396c8295a33ed1ccdfd0509e9fe80 Author: Dominik Schiller Date: Thu Oct 10 09:06:03 2024 +0200 Update index.rst commit 82ab1cc8f55bfeb972ca74ee144291254a16b431 Author: Dominik Schiller Date: Thu Oct 10 09:02:52 2024 +0200 Workflow test branch (#3) * Update README.md * Rename Nova-Server to DISCOVER in doc strings * Update execution_handler.py * Update index.rst * Squashed commit of the following: commit e015df5c1defd8b39d4cd9b09b56dd893f4f0b8c Author: dominik <907555+shelm@users.noreply.github.com> Date: Wed Oct 9 13:20:42 2024 +0200 Fix naming bug for tmp dir variable commit eac00df310fa30af574f27a1bbfbf39de72f41dc Merge: 1ff233a b8593ee Author: Dominik Schiller Date: Wed Oct 9 13:11:57 2024 +0200 Merge pull request #2 from hcmlab/workflow_test_branch Update Documentation Workflow commit 1ff233a525b7e440dcfb23434f4f42818320c4df Author: Dominik Schiller Date: Wed Oct 9 13:06:02 2024 +0200 Update build-doc.yml commit 12900e4409031f4e6284682ef709403e82b3d441 Author: Dominik Schiller Date: Wed Oct 9 13:04:14 2024 +0200 Update build-doc.yml commit d77cdd696288f45a9ce7156eed7a40f97ddf3046 Author: Dominik Schiller Date: Wed Oct 9 12:53:59 2024 +0200 Update build-doc.yml commit ad66db072c375c1599f250e99ba5ce68bccb52c7 Author: Dominik Schiller Date: Wed Oct 9 12:51:22 2024 +0200 Update build-doc.yml --------- Co-authored-by: dominik <907555+shelm@users.noreply.github.com> commit e015df5c1defd8b39d4cd9b09b56dd893f4f0b8c Author: dominik <907555+shelm@users.noreply.github.com> Date: Wed Oct 9 13:20:42 2024 +0200 Fix naming bug for tmp dir variable commit eac00df310fa30af574f27a1bbfbf39de72f41dc Merge: 1ff233a b8593ee Author: Dominik Schiller Date: Wed Oct 9 13:11:57 2024 +0200 Merge pull request #2 from hcmlab/workflow_test_branch Update Documentation Workflow commit 1ff233a525b7e440dcfb23434f4f42818320c4df Author: Dominik Schiller Date: Wed Oct 9 13:06:02 2024 +0200 Update build-doc.yml commit 12900e4409031f4e6284682ef709403e82b3d441 Author: Dominik Schiller Date: Wed Oct 9 13:04:14 2024 +0200 Update build-doc.yml commit d77cdd696288f45a9ce7156eed7a40f97ddf3046 Author: Dominik Schiller Date: Wed Oct 9 12:53:59 2024 +0200 Update build-doc.yml commit ad66db072c375c1599f250e99ba5ce68bccb52c7 Author: Dominik Schiller Date: Wed Oct 9 12:51:22 2024 +0200 Update build-doc.yml * Update Readme * Add modules documentation * Update index.rst * Update blazeface_link.md * Remove unnecessary api docs and add module rst file for blazeface * Update build-doc.yml * Update build-doc.yml * Add mdinclude * Update conf.py * Update conf.py * Test ne rst inclusion * Update index.rst * Update index.rst * Update index.rst * Update index.rst * Test * Update * Update index.rst * Update index.rst * Update index.rst * Update index.rst * Update * Update index.rst * Update index.rst * Update index.rst * Update index.rst * Update index.rst * Update index.rst * Add toml project to requirements * Update readme and fix typos --------- Co-authored-by: dominik <907555+shelm@users.noreply.github.com> --- .github/workflows/build-doc.yml | 10 +++++-- README.md | 2 +- discover/backend/virtual_environment.py | 2 +- docs/docsource/api/.gitkeep | 0 docs/docsource/api/modules.rst | 7 ----- docs/docsource/api/nova_server.app.rst | 7 ----- docs/docsource/api/nova_server.backend.rst | 15 ---------- ...ova_server.backend.virtual_environment.rst | 7 ----- .../api/nova_server.data.adjectives.rst | 7 ----- .../api/nova_server.data.animals.rst | 7 ----- .../docsource/api/nova_server.data.colors.rst | 7 ----- .../api/nova_server.data.countries.rst | 7 ----- .../api/nova_server.data.languages.rst | 7 ----- docs/docsource/api/nova_server.data.names.rst | 7 ----- docs/docsource/api/nova_server.data.rst | 21 -------------- .../api/nova_server.data.star_wars.rst | 7 ----- .../nova_server.exec.execution_handler.rst | 7 ----- docs/docsource/api/nova_server.exec.rst | 15 ---------- .../api/nova_server.route.cancel.rst | 7 ----- .../api/nova_server.route.cml_info.rst | 7 ----- .../nova_server.route.deprecated_extract.rst | 7 ----- .../nova_server.route.deprecated_train.rst | 7 ----- .../api/nova_server.route.explain.rst | 7 ----- .../api/nova_server.route.extract.rst | 7 ----- .../api/nova_server.route.fetch_result.rst | 7 ----- docs/docsource/api/nova_server.route.log.rst | 7 ----- .../api/nova_server.route.predict.rst | 7 ----- .../api/nova_server.route.process.rst | 7 ----- docs/docsource/api/nova_server.route.rst | 27 ------------------ .../api/nova_server.route.status.rst | 7 ----- .../docsource/api/nova_server.route.train.rst | 7 ----- docs/docsource/api/nova_server.route.ui.rst | 7 ----- docs/docsource/api/nova_server.rst | 28 ------------------- docs/docsource/api/nova_server.templates.rst | 7 ----- ..._server.utils.deprecated_dataset_utils.rst | 7 ----- .../nova_server.utils.deprecated_db_utils.rst | 7 ----- ..._server.utils.deprecated_explain_utils.rst | 7 ----- docs/docsource/api/nova_server.utils.env.rst | 7 ----- .../api/nova_server.utils.import_utils.rst | 7 ----- .../api/nova_server.utils.job_utils.rst | 7 ----- .../api/nova_server.utils.log_utils.rst | 7 ----- docs/docsource/api/nova_server.utils.rst | 23 --------------- .../api/nova_server.utils.thread_utils.rst | 7 ----- .../api/nova_server.utils.venv_utils.rst | 7 ----- docs/docsource/conf.py | 5 ++-- docs/docsource/index.rst | 19 +++++++++---- docs/docsource/modules/blazeface.rst | 1 + docs/docsource/modules/diaristation.rst | 1 + docs/docsource/modules/facemesh.rst | 1 + docs/docsource/modules/libreface.rst | 1 + docs/docsource/modules/overview_link.md | 2 -- docs/docsource/modules/whisperx.rst | 1 + docs/docsource/modules/whisperx_link.md | 2 -- docs/docsource/tutorials/introduction.md | 3 +- pyproject.toml | 1 + 55 files changed, 33 insertions(+), 385 deletions(-) delete mode 100644 docs/docsource/api/.gitkeep delete mode 100644 docs/docsource/api/modules.rst delete mode 100644 docs/docsource/api/nova_server.app.rst delete mode 100644 docs/docsource/api/nova_server.backend.rst delete mode 100644 docs/docsource/api/nova_server.backend.virtual_environment.rst delete mode 100644 docs/docsource/api/nova_server.data.adjectives.rst delete mode 100644 docs/docsource/api/nova_server.data.animals.rst delete mode 100644 docs/docsource/api/nova_server.data.colors.rst delete mode 100644 docs/docsource/api/nova_server.data.countries.rst delete mode 100644 docs/docsource/api/nova_server.data.languages.rst delete mode 100644 docs/docsource/api/nova_server.data.names.rst delete mode 100644 docs/docsource/api/nova_server.data.rst delete mode 100644 docs/docsource/api/nova_server.data.star_wars.rst delete mode 100644 docs/docsource/api/nova_server.exec.execution_handler.rst delete mode 100644 docs/docsource/api/nova_server.exec.rst delete mode 100644 docs/docsource/api/nova_server.route.cancel.rst delete mode 100644 docs/docsource/api/nova_server.route.cml_info.rst delete mode 100644 docs/docsource/api/nova_server.route.deprecated_extract.rst delete mode 100644 docs/docsource/api/nova_server.route.deprecated_train.rst delete mode 100644 docs/docsource/api/nova_server.route.explain.rst delete mode 100644 docs/docsource/api/nova_server.route.extract.rst delete mode 100644 docs/docsource/api/nova_server.route.fetch_result.rst delete mode 100644 docs/docsource/api/nova_server.route.log.rst delete mode 100644 docs/docsource/api/nova_server.route.predict.rst delete mode 100644 docs/docsource/api/nova_server.route.process.rst delete mode 100644 docs/docsource/api/nova_server.route.rst delete mode 100644 docs/docsource/api/nova_server.route.status.rst delete mode 100644 docs/docsource/api/nova_server.route.train.rst delete mode 100644 docs/docsource/api/nova_server.route.ui.rst delete mode 100644 docs/docsource/api/nova_server.rst delete mode 100644 docs/docsource/api/nova_server.templates.rst delete mode 100644 docs/docsource/api/nova_server.utils.deprecated_dataset_utils.rst delete mode 100644 docs/docsource/api/nova_server.utils.deprecated_db_utils.rst delete mode 100644 docs/docsource/api/nova_server.utils.deprecated_explain_utils.rst delete mode 100644 docs/docsource/api/nova_server.utils.env.rst delete mode 100644 docs/docsource/api/nova_server.utils.import_utils.rst delete mode 100644 docs/docsource/api/nova_server.utils.job_utils.rst delete mode 100644 docs/docsource/api/nova_server.utils.log_utils.rst delete mode 100644 docs/docsource/api/nova_server.utils.rst delete mode 100644 docs/docsource/api/nova_server.utils.thread_utils.rst delete mode 100644 docs/docsource/api/nova_server.utils.venv_utils.rst create mode 100644 docs/docsource/modules/blazeface.rst create mode 100644 docs/docsource/modules/diaristation.rst create mode 100644 docs/docsource/modules/facemesh.rst create mode 100644 docs/docsource/modules/libreface.rst delete mode 100644 docs/docsource/modules/overview_link.md create mode 100644 docs/docsource/modules/whisperx.rst delete mode 100644 docs/docsource/modules/whisperx_link.md diff --git a/.github/workflows/build-doc.yml b/.github/workflows/build-doc.yml index 3fb2b19..1550002 100644 --- a/.github/workflows/build-doc.yml +++ b/.github/workflows/build-doc.yml @@ -13,11 +13,17 @@ jobs: with: repository: hcmlab/discover-utils path: discover-utils - ref: refs/heads/main + ref: refs/heads/main + - name: Checkout discover modules + uses: actions/checkout@master + with: + repository: hcmlab/discover-modules + path: docs/discover-modules + ref: refs/heads/main - uses: actions/setup-python@v3 - name: Install dependencies run: | - pip install sphinx sphinx_rtd_theme myst-parser sphinx-argparse==0.5.2 + pip install sphinx sphinx_rtd_theme myst-parser sphinx-argparse==0.5.2 sphinx-mdinclude - name: Sphinx build run: | sphinx-apidoc -e -M -d 8 -o docs/docsource/api discover diff --git a/README.md b/README.md index 2018125..f5c784d 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ DISCOVER takes the following optional arguments as input: Internally DISCOVER converts the input to environment variables with the following names: -```DISCOVER_SERVER_HOST```, ```DISCOVER_PORT```, ```DISCOVER_CML_DIR```, ```DISCOVER_CML_DIR```, ```DISCOVER_CML_DIR```, ```DISCOVER_CML_DIR```, ```DISCOVER_CML_DIR``` +```DISCOVER_SERVER_HOST```, ```DISCOVER_PORT```, ```DISCOVER_CML_DIR```, ```DISCOVER_DATA_DIR```, ```DISCOVER_TMP_DIR```, ```DISCOVER_CML_DIR```, ```DISCOVER_LOG_DIR``` All variables can be either passed directly as commandline argument, set in a [dotenv](https://hexdocs.pm/dotenvy/dotenv-file-format.html) file or as system wide environment variables. diff --git a/discover/backend/virtual_environment.py b/discover/backend/virtual_environment.py index ddf86a2..cd1a589 100644 --- a/discover/backend/virtual_environment.py +++ b/discover/backend/virtual_environment.py @@ -314,7 +314,7 @@ def run_shell_script( raise subprocess.CalledProcessError(returncode=return_code, cmd=run_cmd) def kill(self): - """Kills parent and children processess""" + """Kills parent and children processes""" parent = psutil.Process(self.current_process.pid) # kill all the child processes for child in parent.children(recursive=True): diff --git a/docs/docsource/api/.gitkeep b/docs/docsource/api/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/docsource/api/modules.rst b/docs/docsource/api/modules.rst deleted file mode 100644 index 4e4278e..0000000 --- a/docs/docsource/api/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova_server -=========== - -.. toctree:: - :maxdepth: 8 - - nova_server diff --git a/docs/docsource/api/nova_server.app.rst b/docs/docsource/api/nova_server.app.rst deleted file mode 100644 index c4bd901..0000000 --- a/docs/docsource/api/nova_server.app.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.app module -======================= - -.. automodule:: nova_server.app - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.backend.rst b/docs/docsource/api/nova_server.backend.rst deleted file mode 100644 index 37aab2c..0000000 --- a/docs/docsource/api/nova_server.backend.rst +++ /dev/null @@ -1,15 +0,0 @@ -nova\_server.backend package -============================ - -.. automodule:: nova_server.backend - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 8 - - nova_server.backend.virtual_environment diff --git a/docs/docsource/api/nova_server.backend.virtual_environment.rst b/docs/docsource/api/nova_server.backend.virtual_environment.rst deleted file mode 100644 index f1eec01..0000000 --- a/docs/docsource/api/nova_server.backend.virtual_environment.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.backend.virtual\_environment module -================================================ - -.. automodule:: nova_server.backend.virtual_environment - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.data.adjectives.rst b/docs/docsource/api/nova_server.data.adjectives.rst deleted file mode 100644 index 3f3cf84..0000000 --- a/docs/docsource/api/nova_server.data.adjectives.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.data.adjectives module -=================================== - -.. automodule:: nova_server.data.adjectives - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.data.animals.rst b/docs/docsource/api/nova_server.data.animals.rst deleted file mode 100644 index 29605fb..0000000 --- a/docs/docsource/api/nova_server.data.animals.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.data.animals module -================================ - -.. automodule:: nova_server.data.animals - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.data.colors.rst b/docs/docsource/api/nova_server.data.colors.rst deleted file mode 100644 index 1e0e3cf..0000000 --- a/docs/docsource/api/nova_server.data.colors.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.data.colors module -=============================== - -.. automodule:: nova_server.data.colors - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.data.countries.rst b/docs/docsource/api/nova_server.data.countries.rst deleted file mode 100644 index 016fa70..0000000 --- a/docs/docsource/api/nova_server.data.countries.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.data.countries module -================================== - -.. automodule:: nova_server.data.countries - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.data.languages.rst b/docs/docsource/api/nova_server.data.languages.rst deleted file mode 100644 index 4729ac6..0000000 --- a/docs/docsource/api/nova_server.data.languages.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.data.languages module -================================== - -.. automodule:: nova_server.data.languages - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.data.names.rst b/docs/docsource/api/nova_server.data.names.rst deleted file mode 100644 index 250b2bb..0000000 --- a/docs/docsource/api/nova_server.data.names.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.data.names module -============================== - -.. automodule:: nova_server.data.names - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.data.rst b/docs/docsource/api/nova_server.data.rst deleted file mode 100644 index 79f3d3d..0000000 --- a/docs/docsource/api/nova_server.data.rst +++ /dev/null @@ -1,21 +0,0 @@ -nova\_server.data package -========================= - -.. automodule:: nova_server.data - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 8 - - nova_server.data.adjectives - nova_server.data.animals - nova_server.data.colors - nova_server.data.countries - nova_server.data.languages - nova_server.data.names - nova_server.data.star_wars diff --git a/docs/docsource/api/nova_server.data.star_wars.rst b/docs/docsource/api/nova_server.data.star_wars.rst deleted file mode 100644 index 49b83e9..0000000 --- a/docs/docsource/api/nova_server.data.star_wars.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.data.star\_wars module -=================================== - -.. automodule:: nova_server.data.star_wars - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.exec.execution_handler.rst b/docs/docsource/api/nova_server.exec.execution_handler.rst deleted file mode 100644 index 9bb630b..0000000 --- a/docs/docsource/api/nova_server.exec.execution_handler.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.exec.execution\_handler module -=========================================== - -.. automodule:: nova_server.exec.execution_handler - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.exec.rst b/docs/docsource/api/nova_server.exec.rst deleted file mode 100644 index c60f1d7..0000000 --- a/docs/docsource/api/nova_server.exec.rst +++ /dev/null @@ -1,15 +0,0 @@ -nova\_server.exec package -========================= - -.. automodule:: nova_server.exec - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 8 - - nova_server.exec.execution_handler diff --git a/docs/docsource/api/nova_server.route.cancel.rst b/docs/docsource/api/nova_server.route.cancel.rst deleted file mode 100644 index f591167..0000000 --- a/docs/docsource/api/nova_server.route.cancel.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.cancel module -================================ - -.. automodule:: nova_server.route.cancel - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.cml_info.rst b/docs/docsource/api/nova_server.route.cml_info.rst deleted file mode 100644 index 5f9e257..0000000 --- a/docs/docsource/api/nova_server.route.cml_info.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.cml\_info module -=================================== - -.. automodule:: nova_server.route.cml_info - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.deprecated_extract.rst b/docs/docsource/api/nova_server.route.deprecated_extract.rst deleted file mode 100644 index 2a5ae13..0000000 --- a/docs/docsource/api/nova_server.route.deprecated_extract.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.deprecated\_extract module -============================================= - -.. automodule:: nova_server.route.deprecated_extract - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.deprecated_train.rst b/docs/docsource/api/nova_server.route.deprecated_train.rst deleted file mode 100644 index 28267f4..0000000 --- a/docs/docsource/api/nova_server.route.deprecated_train.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.deprecated\_train module -=========================================== - -.. automodule:: nova_server.route.deprecated_train - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.explain.rst b/docs/docsource/api/nova_server.route.explain.rst deleted file mode 100644 index fa03529..0000000 --- a/docs/docsource/api/nova_server.route.explain.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.explain module -================================= - -.. automodule:: nova_server.route.explain - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.extract.rst b/docs/docsource/api/nova_server.route.extract.rst deleted file mode 100644 index 1622fb1..0000000 --- a/docs/docsource/api/nova_server.route.extract.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.extract module -================================= - -.. automodule:: nova_server.route.extract - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.fetch_result.rst b/docs/docsource/api/nova_server.route.fetch_result.rst deleted file mode 100644 index 23a131c..0000000 --- a/docs/docsource/api/nova_server.route.fetch_result.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.fetch\_result module -======================================= - -.. automodule:: nova_server.route.fetch_result - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.log.rst b/docs/docsource/api/nova_server.route.log.rst deleted file mode 100644 index 230d168..0000000 --- a/docs/docsource/api/nova_server.route.log.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.log module -============================= - -.. automodule:: nova_server.route.log - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.predict.rst b/docs/docsource/api/nova_server.route.predict.rst deleted file mode 100644 index fbcf205..0000000 --- a/docs/docsource/api/nova_server.route.predict.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.predict module -================================= - -.. automodule:: nova_server.route.predict - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.process.rst b/docs/docsource/api/nova_server.route.process.rst deleted file mode 100644 index 2bf5c36..0000000 --- a/docs/docsource/api/nova_server.route.process.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.process module -================================= - -.. automodule:: nova_server.route.process - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.rst b/docs/docsource/api/nova_server.route.rst deleted file mode 100644 index f5cb6f0..0000000 --- a/docs/docsource/api/nova_server.route.rst +++ /dev/null @@ -1,27 +0,0 @@ -nova\_server.route package -========================== - -.. automodule:: nova_server.route - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 8 - - nova_server.route.cancel - nova_server.route.cml_info - nova_server.route.deprecated_extract - nova_server.route.deprecated_train - nova_server.route.explain - nova_server.route.extract - nova_server.route.fetch_result - nova_server.route.log - nova_server.route.predict - nova_server.route.process - nova_server.route.status - nova_server.route.train - nova_server.route.ui diff --git a/docs/docsource/api/nova_server.route.status.rst b/docs/docsource/api/nova_server.route.status.rst deleted file mode 100644 index dc102d4..0000000 --- a/docs/docsource/api/nova_server.route.status.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.status module -================================ - -.. automodule:: nova_server.route.status - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.train.rst b/docs/docsource/api/nova_server.route.train.rst deleted file mode 100644 index 249d899..0000000 --- a/docs/docsource/api/nova_server.route.train.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.train module -=============================== - -.. automodule:: nova_server.route.train - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.route.ui.rst b/docs/docsource/api/nova_server.route.ui.rst deleted file mode 100644 index ffc4f88..0000000 --- a/docs/docsource/api/nova_server.route.ui.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.route.ui module -============================ - -.. automodule:: nova_server.route.ui - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.rst b/docs/docsource/api/nova_server.rst deleted file mode 100644 index 886b707..0000000 --- a/docs/docsource/api/nova_server.rst +++ /dev/null @@ -1,28 +0,0 @@ -nova\_server package -==================== - -.. automodule:: nova_server - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - :maxdepth: 8 - - nova_server.backend - nova_server.data - nova_server.exec - nova_server.route - nova_server.templates - nova_server.utils - -Submodules ----------- - -.. toctree:: - :maxdepth: 8 - - nova_server.app diff --git a/docs/docsource/api/nova_server.templates.rst b/docs/docsource/api/nova_server.templates.rst deleted file mode 100644 index ff65670..0000000 --- a/docs/docsource/api/nova_server.templates.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.templates package -============================== - -.. automodule:: nova_server.templates - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.utils.deprecated_dataset_utils.rst b/docs/docsource/api/nova_server.utils.deprecated_dataset_utils.rst deleted file mode 100644 index 1d0ade2..0000000 --- a/docs/docsource/api/nova_server.utils.deprecated_dataset_utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.utils.deprecated\_dataset\_utils module -==================================================== - -.. automodule:: nova_server.utils.deprecated_dataset_utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.utils.deprecated_db_utils.rst b/docs/docsource/api/nova_server.utils.deprecated_db_utils.rst deleted file mode 100644 index 904af36..0000000 --- a/docs/docsource/api/nova_server.utils.deprecated_db_utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.utils.deprecated\_db\_utils module -=============================================== - -.. automodule:: nova_server.utils.deprecated_db_utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.utils.deprecated_explain_utils.rst b/docs/docsource/api/nova_server.utils.deprecated_explain_utils.rst deleted file mode 100644 index d00674e..0000000 --- a/docs/docsource/api/nova_server.utils.deprecated_explain_utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.utils.deprecated\_explain\_utils module -==================================================== - -.. automodule:: nova_server.utils.deprecated_explain_utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.utils.env.rst b/docs/docsource/api/nova_server.utils.env.rst deleted file mode 100644 index b8573f6..0000000 --- a/docs/docsource/api/nova_server.utils.env.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.utils.env module -============================= - -.. automodule:: nova_server.utils.env - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.utils.import_utils.rst b/docs/docsource/api/nova_server.utils.import_utils.rst deleted file mode 100644 index 4cb4545..0000000 --- a/docs/docsource/api/nova_server.utils.import_utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.utils.import\_utils module -======================================= - -.. automodule:: nova_server.utils.import_utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.utils.job_utils.rst b/docs/docsource/api/nova_server.utils.job_utils.rst deleted file mode 100644 index b2558a8..0000000 --- a/docs/docsource/api/nova_server.utils.job_utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.utils.job\_utils module -==================================== - -.. automodule:: nova_server.utils.job_utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.utils.log_utils.rst b/docs/docsource/api/nova_server.utils.log_utils.rst deleted file mode 100644 index f7a4aec..0000000 --- a/docs/docsource/api/nova_server.utils.log_utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.utils.log\_utils module -==================================== - -.. automodule:: nova_server.utils.log_utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.utils.rst b/docs/docsource/api/nova_server.utils.rst deleted file mode 100644 index 98b6ef7..0000000 --- a/docs/docsource/api/nova_server.utils.rst +++ /dev/null @@ -1,23 +0,0 @@ -nova\_server.utils package -========================== - -.. automodule:: nova_server.utils - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 8 - - nova_server.utils.deprecated_dataset_utils - nova_server.utils.deprecated_db_utils - nova_server.utils.deprecated_explain_utils - nova_server.utils.env - nova_server.utils.import_utils - nova_server.utils.job_utils - nova_server.utils.log_utils - nova_server.utils.thread_utils - nova_server.utils.venv_utils diff --git a/docs/docsource/api/nova_server.utils.thread_utils.rst b/docs/docsource/api/nova_server.utils.thread_utils.rst deleted file mode 100644 index b7e9839..0000000 --- a/docs/docsource/api/nova_server.utils.thread_utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.utils.thread\_utils module -======================================= - -.. automodule:: nova_server.utils.thread_utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/api/nova_server.utils.venv_utils.rst b/docs/docsource/api/nova_server.utils.venv_utils.rst deleted file mode 100644 index 0c753c9..0000000 --- a/docs/docsource/api/nova_server.utils.venv_utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -nova\_server.utils.venv\_utils module -===================================== - -.. automodule:: nova_server.utils.venv_utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/docsource/conf.py b/docs/docsource/conf.py index e6c75c7..cb5d59e 100644 --- a/docs/docsource/conf.py +++ b/docs/docsource/conf.py @@ -27,10 +27,11 @@ 'sphinx.ext.napoleon', 'sphinx.ext.todo', 'sphinx.ext.viewcode', - 'myst_parser' + 'sphinx_mdinclude', + #'myst_parser' ] -source_suffix = ['.rst', '.md'] +source_suffix = ['.rst'] autodoc_typehints = "none" #napoleon_use_param = False napoleon_google_docstring = True # Enable parsing of Google-style pydocs. diff --git a/docs/docsource/index.rst b/docs/docsource/index.rst index 8dd2343..9cbbe36 100644 --- a/docs/docsource/index.rst +++ b/docs/docsource/index.rst @@ -6,7 +6,7 @@ :github_url: https://github.com/hcmlab/discover -DISCOVER documentation! +DISCOVER documentation ====================================== DISCOVER is an open-source software framework designed to facilitate computational-driven data exploration in human behavior analysis. @@ -18,7 +18,18 @@ This user-friendly and modular platform streamlines complex methodologies, enabl tutorials/introduction tutorials/examples - + +.. toctree:: + :maxdepth: 2 + :caption: Modules + + modules/blazeface + modules/diaristation + modules/facemesh + modules/libreface + modules/whisperx + + .. toctree:: :maxdepth: 2 :caption: Packages @@ -29,11 +40,7 @@ This user-friendly and modular platform streamlines complex methodologies, enabl api/discover.route api/discover.utils -.. toctree:: - :maxdepth: 2 - :caption: Modules - modules/overview_link.md Indices and tables diff --git a/docs/docsource/modules/blazeface.rst b/docs/docsource/modules/blazeface.rst new file mode 100644 index 0000000..d84121b --- /dev/null +++ b/docs/docsource/modules/blazeface.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../discover-modules/modules/blazeface/README.md diff --git a/docs/docsource/modules/diaristation.rst b/docs/docsource/modules/diaristation.rst new file mode 100644 index 0000000..d20e1b2 --- /dev/null +++ b/docs/docsource/modules/diaristation.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../discover-modules/modules/diaristation/README.md diff --git a/docs/docsource/modules/facemesh.rst b/docs/docsource/modules/facemesh.rst new file mode 100644 index 0000000..ec3ba3a --- /dev/null +++ b/docs/docsource/modules/facemesh.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../discover-modules/modules/facemesh/README.md diff --git a/docs/docsource/modules/libreface.rst b/docs/docsource/modules/libreface.rst new file mode 100644 index 0000000..eb2a30b --- /dev/null +++ b/docs/docsource/modules/libreface.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../discover-modules/modules/libreface/README.md diff --git a/docs/docsource/modules/overview_link.md b/docs/docsource/modules/overview_link.md deleted file mode 100644 index 41c1fff..0000000 --- a/docs/docsource/modules/overview_link.md +++ /dev/null @@ -1,2 +0,0 @@ -```{include} ../../../../modules/README.md -``` \ No newline at end of file diff --git a/docs/docsource/modules/whisperx.rst b/docs/docsource/modules/whisperx.rst new file mode 100644 index 0000000..c442ea7 --- /dev/null +++ b/docs/docsource/modules/whisperx.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../discover-modules/modules/whisperx/README.md diff --git a/docs/docsource/modules/whisperx_link.md b/docs/docsource/modules/whisperx_link.md deleted file mode 100644 index e312e9a..0000000 --- a/docs/docsource/modules/whisperx_link.md +++ /dev/null @@ -1,2 +0,0 @@ -```{include} ../../../../nova-server-modules/models/trainer/free/transcript/whisperx/readme.md -``` \ No newline at end of file diff --git a/docs/docsource/tutorials/introduction.md b/docs/docsource/tutorials/introduction.md index 37a3a76..4124a44 100644 --- a/docs/docsource/tutorials/introduction.md +++ b/docs/docsource/tutorials/introduction.md @@ -78,8 +78,7 @@ DISCOVER takes the following optional arguments as input: Internally DISCOVER converts the input to environment variables with the following names: -```DISCOVER_SERVER_HOST```, ```DISCOVER_PORT```, ```DISCOVER_CML_DIR```, ```DISCOVER_CML_DIR```, ```DISCOVER_CML_DIR```, ```DISCOVER_CML_DIR```, ```DISCOVER_CML_DIR``` - +```DISCOVER_SERVER_HOST```, ```DISCOVER_PORT```, ```DISCOVER_CML_DIR```, ```DISCOVER_DATA_DIR```, ```DISCOVER_TMP_DIR```, ```DISCOVER_CML_DIR```, ```DISCOVER_LOG_DIR``` All variables can be either passed directly as commandline argument, set in a [dotenv](https://hexdocs.pm/dotenvy/dotenv-file-format.html) file or as system wide environment variables. During runtime the arguments will be prioritized in this order commandline arguments -> dotenv file -> environment variable -> default value. diff --git a/pyproject.toml b/pyproject.toml index 0349324..2a5d924 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -31,6 +31,7 @@ dependencies = [ "python-dotenv", "psutil", "numpy >= 1.24, < 2.0", + "toml" ] dynamic = ["version"]