[Bugfix] Fix docusaurus config that prevents the docs unable to deploy in AiCure repo
This commit is contained in:
@@ -8,7 +8,7 @@ const commonDocsOptions = {
|
||||
breadcrumbs: false,
|
||||
showLastUpdateAuthor: false,
|
||||
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')],
|
||||
};
|
||||
|
||||
@@ -16,10 +16,10 @@ const commonDocsOptions = {
|
||||
module.exports = {
|
||||
title: 'OpenDBM',
|
||||
tagline: 'AiCure Digital Biomaker Tools',
|
||||
organizationName: 'teebid',
|
||||
projectName: 'aicure_opendbm',
|
||||
url: 'https://teebid.github.io',
|
||||
baseUrl: '/aicure_opendbm/',
|
||||
organizationName: 'AiCure',
|
||||
projectName: 'open_dbm',
|
||||
url: 'https://aicure.github.io',
|
||||
baseUrl: '/open_dbm/',
|
||||
clientModules: [require.resolve('./snackPlayerInitializer.js')],
|
||||
trailingSlash: false, // because trailing slashes can break some existing relative links
|
||||
scripts: [
|
||||
@@ -239,7 +239,6 @@ module.exports = {
|
||||
docId: 'extras',
|
||||
position: 'right',
|
||||
docsPluginId: 'extras',
|
||||
|
||||
},
|
||||
|
||||
{
|
||||
@@ -356,13 +355,13 @@ module.exports = {
|
||||
{
|
||||
property: 'og:image',
|
||||
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:image',
|
||||
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'},
|
||||
],
|
||||
|
||||
@@ -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:
|
||||
* ```bash yarn``` to install all the dependencies
|
||||
* 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
|
||||
cd website
|
||||
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/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/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
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"license": "CC-BY-4.0",
|
||||
"homepage": "https://teebid.github.io/aicure_opendbm/",
|
||||
"repository": "github:teebid/aicure_opendbm",
|
||||
"homepage": "https://aicure.github.io/open_dbm/",
|
||||
"repository": "github:aicure/open_dbm",
|
||||
"bugs": {
|
||||
"url": "https://github.com/AiCure/open_dbm/issues"
|
||||
},
|
||||
|
||||
18
readme.md
18
readme.md
@@ -36,10 +36,10 @@ At a modular level, OpenDBM is a library that consists of the following componen
|
||||
|
||||
| Component | Description |
|
||||
| ---- | --- |
|
||||
| [**Facial**](https://teebid.github.io/aicure_opendbm/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 |
|
||||
| [**Acoustic**](https://teebid.github.io/aicure_opendbm/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 |
|
||||
| [**Facial**](https://aicure.github.io/open_dbm/docs/category/api/facial) | An OpenDBM module to get facial attributes |
|
||||
| [**Movement**](https://aicure.github.io/open_dbm/docs/category/api/movement) | An OpenDBM module to get movement attributes |
|
||||
| [**Acoustic**](https://aicure.github.io/open_dbm/docs/category/api/acoustic) | An OpenDBM module to get acoustic attributes |
|
||||
| [**Audio**](https://aicure.github.io/open_dbm/docs/category/api/audio) | An OpenDBM module to get audio attributes |
|
||||
|
||||
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
|
||||
```
|
||||
### 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
|
||||
```bash
|
||||
pip install opendbm
|
||||
@@ -89,7 +89,7 @@ pip install opendbm
|
||||
## Model Download ( Facial and Movement Components)
|
||||
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
|
||||
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:
|
||||
|
||||
- [Introduction to OpenDBM](https://teebid.github.io/aicure_opendbm/docs/intro)
|
||||
- [Advance Guide](https://teebid.github.io/aicure_opendbm/docs/advance)
|
||||
- [API Documentation](https://teebid.github.io/aicure_opendbm/docs/category/api)
|
||||
- [Introduction to OpenDBM](https://aicure.github.io/open_dbm/docs/intro)
|
||||
- [Advance Guide](https://aicure.github.io/open_dbm/docs/advance)
|
||||
- [API Documentation](https://aicure.github.io/open_dbm/docs/category/api)
|
||||
|
||||
<div align="right">
|
||||
<a href="#table-of-contents">Back to TOC ☝️</a>
|
||||
|
||||
Reference in New Issue
Block a user