Merge pull request #574 from jay-m-dev/api_docs

added lab_api to documentation
EpistasisLab · Feb 1, 2023 · 6bdf777 · 6bdf777
2 parents 0e83003 + bdb36e3
commit 6bdf777
Show file tree

Hide file tree

Showing 8 changed files with 159 additions and 68 deletions.
diff --git a/docker-compose-doc-builder.yml b/docker-compose-doc-builder.yml
@@ -6,11 +6,18 @@ services:
       context: .
       dockerfile: docs/Dockerfile
       args:
-        - USE_WHEELS=0
+        - USE_WHEELS=1
     working_dir: /appsrc/docs
     command: bash -c "make html"
     tty: true
     stdin_open: true
     volumes:
       - "./:/appsrc"
       - "/appsrc/lab/webapp/node_modules"
+
+  doc_api_builder:
+    image: "node:18.13.0-slim"
+    command: bash -c "npm i -g raml2html && raml2html /appsrc/lab/api.raml > 
+      /appsrc/target/ai_docs/html/lab_api_source.html"
+    volumes:
+      - "./:/appsrc"
diff --git a/docs/Dockerfile b/docs/Dockerfile
@@ -3,6 +3,8 @@ FROM python:3.7.16-buster
 ARG USE_WHEELS
 ARG wheel_directory=docker/wheels
 
+RUN pip install --upgrade pip
+
 COPY /docs/requirements.txt /
 RUN pip install -r /requirements.txt
 

diff --git a/docs/guides/developerGuide.md b/docs/guides/developerGuide.md
@@ -414,3 +414,7 @@ dev tag should be `0.19a0`.
 
 1. From the Aliro directory, run the command `docker-compose up` to start the
 Aliro server.
+
+
+<!-- ## Aliro Lab API -->
+<!-- <iframe src="lab_api.html" width="100%" height="100%"></iframe> -->
diff --git a/docs/guides/userGuide.md b/docs/guides/userGuide.md
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -51,8 +51,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Aliro'
-copyright = '2018, Penn'
-author = 'University of Pennsylvania'
+copyright = '2023, Cedars-Sinai Medical Center'
+author = 'Cedars-Sinai Medical Center'
 
 # read version from .env
 env = Env()

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -18,6 +18,7 @@ And, it has an *AI* assistant that can choose the analysis to run for you.
    quickstart
    userguide
    developerguide
+   lab_api
    ai
    recommenders
    api

diff --git a/docs/source/lab_api.rst b/docs/source/lab_api.rst
@@ -0,0 +1,6 @@
+Lab API
+=======
+
+.. raw:: html
+
+   <iframe src="lab_api_source.html" width="100%" height="1200px"></iframe>
diff --git a/lab/api.raml b/lab/api.raml
@@ -335,28 +335,28 @@ mediaType: application/json
           application/json:
             example:  |
               {
-              [ { name: 'BernoulliNB',
-                      command: 'python',
-                      cwd: 'machine/learn/BernoulliNB',
-                      args: [Object],
-                      options: 'double-dash',
-                      capacity: '1',
-                      results: 'machine/learn/BernoulliNB/tmp' },
-                    { name: 'DecisionTreeClassifier',
-                      command: 'python',
-                      cwd: 'machine/learn/DecisionTreeClassifier',
-                      args: [Object],
-                      options: 'double-dash',
-                      capacity: '1',
-                      results: 'machine/learn/DecisionTreeClassifier/tmp' },
-                    { name: 'DecisionTreeRegressor',
-                      command: 'python',
-                      cwd: 'machine/learn/DecisionTreeRegressor',
-                      args: [Object],
-                      options: 'double-dash',
-                      capacity: '1',
-                      results: 'machine/learn/DecisionTreeRegressor/tmp' }
-              ]
+                [ { name: 'BernoulliNB',
+                        command: 'python',
+                        cwd: 'machine/learn/BernoulliNB',
+                        args: [Object],
+                        options: 'double-dash',
+                        capacity: '1',
+                        results: 'machine/learn/BernoulliNB/tmp' },
+                      { name: 'DecisionTreeClassifier',
+                        command: 'python',
+                        cwd: 'machine/learn/DecisionTreeClassifier',
+                        args: [Object],
+                        options: 'double-dash',
+                        capacity: '1',
+                        results: 'machine/learn/DecisionTreeClassifier/tmp' },
+                      { name: 'DecisionTreeRegressor',
+                        command: 'python',
+                        cwd: 'machine/learn/DecisionTreeRegressor',
+                        args: [Object],
+                        options: 'double-dash',
+                        capacity: '1',
+                        results: 'machine/learn/DecisionTreeRegressor/tmp' }
+                ]
               }
 /files:
   /{fileId}: