bobby/open_dbm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Bugfix] Fix docusaurus config that prevents the docs unable to deploy in AiCure repo

Browse Source
This commit is contained in:
Muhammad Faisyal
2022-10-16 03:12:14 +07:00
parent 7970d3c86a
commit 9297735f0b
4 changed files with 20 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/website/docusaurus.config.js
View File

@@ -8,7 +8,7 @@ const commonDocsOptions = {
breadcrumbs: false, breadcrumbs: false,
showLastUpdateAuthor: false, showLastUpdateAuthor: false,
showLastUpdateTime: true, showLastUpdateTime: true,
editUrl: 'https://github.com/AiCure/open_dbm/blob/master/docs/', editUrl: 'https://github.com/AiCure/open_dbm/blob/master/docs/docs',
remarkPlugins: [require('@react-native-website/remark-snackplayer')], remarkPlugins: [require('@react-native-website/remark-snackplayer')],
}; };
@@ -16,10 +16,10 @@ const commonDocsOptions = {
module.exports = { module.exports = {
title: 'OpenDBM', title: 'OpenDBM',
tagline: 'AiCure Digital Biomaker Tools', tagline: 'AiCure Digital Biomaker Tools',
organizationName: 'teebid', organizationName: 'AiCure',
projectName: 'aicure_opendbm', projectName: 'open_dbm',
url: 'https://teebid.github.io', url: 'https://aicure.github.io',
baseUrl: '/aicure_opendbm/', baseUrl: '/open_dbm/',
clientModules: [require.resolve('./snackPlayerInitializer.js')], clientModules: [require.resolve('./snackPlayerInitializer.js')],
trailingSlash: false, // because trailing slashes can break some existing relative links trailingSlash: false, // because trailing slashes can break some existing relative links
scripts: [ scripts: [
@@ -239,7 +239,6 @@ module.exports = {
docId: 'extras', docId: 'extras',
position: 'right', position: 'right',
docsPluginId: 'extras', docsPluginId: 'extras',
}, },
{ {
@@ -356,13 +355,13 @@ module.exports = {
{ {
property: 'og:image', property: 'og:image',
content: content:
'https://raw.githubusercontent.com/teebid/aicure_opendbm/master/docs/website/static/img/header_logo.png', 'https://raw.githubusercontent.com/AiCure/open_dbm/master/docs/website/static/img/header_logo.png',
}, },
{name: 'twitter:card', content: 'summary_large_image'}, {name: 'twitter:card', content: 'summary_large_image'},
{ {
name: 'twitter:image', name: 'twitter:image',
content: content:
'https://raw.githubusercontent.com/teebid/aicure_opendbm/master/docs/website/static/img/header_logo.png', 'https://raw.githubusercontent.com/AiCure/open_dbm/master/docs/website/static/img/header_logo.png',
}, },
{name: 'twitter:site', content: '@aicure'}, {name: 'twitter:site', content: '@aicure'},
], ],

5
docs/website/extras/odbm-doc.md
View File

@@ -70,16 +70,15 @@ Your node must be set to stable version (as of now version 16) to be able to ins
Under the docs directory: Under the docs directory:
* ```bash yarn``` to install all the dependencies * ```bash yarn``` to install all the dependencies
* Then go to the the `website` directory and run the app by typing: * Then go to the the `website` directory and run the app by typing:
* Command below is for start the website for the **first time**. * Command below is for start the website for the **first time**. Run below commands under docs/ folder
```bash ```bash
cd website
pip install pydoc-markdown pip install pydoc-markdown
pydoc-markdown -I ../opendbm/api_lib/facial_activity -m api --render-toc > website/api/facial-activity-api.md pydoc-markdown -I ../opendbm/api_lib/facial_activity -m api --render-toc > website/api/facial-activity-api.md
pydoc-markdown -I ../opendbm/api_lib/movement -m api --render-toc > website/api/movement-api.md pydoc-markdown -I ../opendbm/api_lib/movement -m api --render-toc > website/api/movement-api.md
pydoc-markdown -I ../opendbm/api_lib/verbal_acoustics -m api --render-toc > website/api/verbal-acoustics-api.md pydoc-markdown -I ../opendbm/api_lib/verbal_acoustics -m api --render-toc > website/api/verbal-acoustics-api.md
pydoc-markdown -I ../opendbm/api_lib/speech -m api --render-toc > website/api/speech-api.md pydoc-markdown -I ../opendbm/api_lib/speech -m api --render-toc > website/api/speech-api.md
yarn start cd website && yarn start
``` ```
* This command is the one you execute if you have already generated dynamic documentation from pydoc-markdown * This command is the one you execute if you have already generated dynamic documentation from pydoc-markdown

4
docs/website/package.json
View File

@@ -4,8 +4,8 @@
"version": "0.0.1", "version": "0.0.1",
"private": true, "private": true,
"license": "CC-BY-4.0", "license": "CC-BY-4.0",
"homepage": "https://teebid.github.io/aicure_opendbm/", "homepage": "https://aicure.github.io/open_dbm/",
"repository": "github:teebid/aicure_opendbm", "repository": "github:aicure/open_dbm",
"bugs": { "bugs": {
"url": "https://github.com/AiCure/open_dbm/issues" "url": "https://github.com/AiCure/open_dbm/issues"
}, },

18
readme.md
View File

@@ -36,10 +36,10 @@ At a modular level, OpenDBM is a library that consists of the following componen
| Component | Description | | Component | Description |
| ---- | --- | | ---- | --- |
| [**Facial**](https://teebid.github.io/aicure_opendbm/docs/category/api/facial) | An OpenDBM module to get facial attributes | | [**Facial**](https://aicure.github.io/open_dbm/docs/category/api/facial) | An OpenDBM module to get facial attributes |
| [**Movement**](https://teebid.github.io/aicure_opendbm/docs/category/api/movement) | An OpenDBM module to get movement attributes | | [**Movement**](https://aicure.github.io/open_dbm/docs/category/api/movement) | An OpenDBM module to get movement attributes |
| [**Acoustic**](https://teebid.github.io/aicure_opendbm/docs/category/api/acoustic) | An OpenDBM module to get acoustic attributes | | [**Acoustic**](https://aicure.github.io/open_dbm/docs/category/api/acoustic) | An OpenDBM module to get acoustic attributes |
| [**Audio**](https://teebid.github.io/aicure_opendbm/docs/category/api/audio) | An OpenDBM module to get audio attributes | | [**Audio**](https://aicure.github.io/open_dbm/docs/category/api/audio) | An OpenDBM module to get audio attributes |
Usually, OpenDBM is used for: Usually, OpenDBM is used for:
@@ -80,7 +80,7 @@ conda install -c conda-forge cmake ffmpeg sox
conda install -c conda-forge ffmpeg sox dlib conda install -c conda-forge ffmpeg sox dlib
``` ```
### Without Conda Environment ### Without Conda Environment
[Installation instructions](https://teebid.github.io/aicure_opendbm/docs/dependencies-installation) [Installation instructions](https://aicure.github.io/open_dbm/docs/dependencies-installation)
## OpenDBM Installation ## OpenDBM Installation
```bash ```bash
pip install opendbm pip install opendbm
@@ -89,7 +89,7 @@ pip install opendbm
## Model Download ( Facial and Movement Components) ## Model Download ( Facial and Movement Components)
Make sure you have installed docker and already login to Docker Hub. Make sure you have installed docker and already login to Docker Hub.
If you haven't, Find the tutorial [here](https://teebid.github.io/aicure_opendbm/docs/openface-docker-installation) If you haven't, Find the tutorial [here](https://aicure.github.io/open_dbm/docs/openface-docker-installation)
```bash ```bash
docker pull opendbmteam/dbm-openface docker pull opendbmteam/dbm-openface
``` ```
@@ -122,9 +122,9 @@ landmark.to_dataframe() # convert results as pandas dataframe
For more in-depth tutorials about OpenDBM, you can check out: For more in-depth tutorials about OpenDBM, you can check out:
- [Introduction to OpenDBM](https://teebid.github.io/aicure_opendbm/docs/intro) - [Introduction to OpenDBM](https://aicure.github.io/open_dbm/docs/intro)
- [Advance Guide](https://teebid.github.io/aicure_opendbm/docs/advance) - [Advance Guide](https://aicure.github.io/open_dbm/docs/advance)
- [API Documentation](https://teebid.github.io/aicure_opendbm/docs/category/api) - [API Documentation](https://aicure.github.io/open_dbm/docs/category/api)
<div align="right"> <div align="right">
<a href="#table-of-contents">Back to TOC ☝️</a> <a href="#table-of-contents">Back to TOC ☝️</a>