Merge pull request #26 from bbglab/develop

Release v1.0.0
bbglab · Jul 26, 2024 · 51bad7b · 51bad7b
2 parents 20acac5 + d925079
commit 51bad7b
Show file tree

Hide file tree

Showing 15 changed files with 343 additions and 280 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.7"
+  apt_packages:
+    - gcc
+
+# Build from the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Explicitly set the version of Python and its requirements
+python:
+  install:
+    - requirements: requirements-docs.txt
diff --git a/docs/examples/cli/introduction_cli.ipynb b/docs/examples/cli/introduction_cli.ipynb
@@ -2,33 +2,39 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "source": [
-    "# Introduction"
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "# Introduction"
+   ]
   },
   {
    "cell_type": "markdown",
-   "source": [
-    "**OpenVariant** offers a command-line interface (CLI) with the main tasks that also can be applied in Python scripts.\n",
-    "\n",
-    "On the following command you can check the different options that `openvar` can run."
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "**OpenVariant** offers a command-line interface (CLI) with the main tasks that also can be applied in Python scripts.\n",
+    "\n",
+    "On the following command you can check the different options that `openvar` can run."
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": 1,
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -55,29 +61,29 @@
    "source": [
     "%%bash\n",
     "openvar --help"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   }
+   ]
   },
   {
    "cell_type": "markdown",
-   "source": [
-    "### ***Cat*** command"
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "### **Cat** command"
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": 2,
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -99,29 +105,29 @@
    "source": [
     "%%bash\n",
     "openvar cat --help"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   }
+   ]
   },
   {
    "cell_type": "markdown",
-   "source": [
-    "### ***Count*** command"
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "### **Count** command"
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": 3,
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -145,29 +151,29 @@
    "source": [
     "%%bash\n",
     "openvar count --help"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   }
+   ]
   },
   {
    "cell_type": "markdown",
-   "source": [
-    "### ***Group by*** command"
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "### **Group by** command"
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": 4,
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -195,29 +201,29 @@
    "source": [
     "%%bash\n",
     "openvar groupby --help"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   }
+   ]
   },
   {
    "cell_type": "markdown",
-   "source": [
-    "### ***Plugin*** command"
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "### **Plugin** command"
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": 5,
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -237,13 +243,7 @@
    "source": [
     "%%bash\n",
     "openvar plugin --help"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   }
+   ]
   }
  ],
  "metadata": {
@@ -267,4 +267,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 0
-}
+}