Merge Sphinx into Docusaurus V2 (#206)

* Merge Sphinx into Docusaurus V2

* Add pre-commit fixes

* Update docusaurus.config.js

* Update docusaurus.config.js

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: kailingding

.github/workflows/docs.yml

@@ -36,7 +36,7 @@ jobs:
           node-version: 14
 
       - name: Build documentation
-        run: poetry run make -C docs html
+        run: ./scripts/build_docs.sh
 
       - name: Build Docusaurus website
         run: |

.gitignore

@@ -21,3 +21,6 @@ dist/
 *.h5
 *.npz
 *.pkl
+
+# vscode
+.vscode

docs/source/_templates/theme_variables.jinja

@@ -1,6 +1,6 @@
 {%- set external_urls = {
   'github': 'https://github.com/Rose-STL-Lab/torchTS',
-  'home': 'https://github.com/Rose-STL-Lab/torchTS/',
+  'home': 'https://rose-stl-lab.github.io/torchTS/docs/',
   'get_started': ' ',
   'blog': 'https://github.com/Rose-STL-Lab/torchTS',
   'resources': 'https://github.com/Rose-STL-Lab/torchTS',

docs/source/conf.py

@@ -88,7 +88,7 @@
 # documentation.
 html_theme_options = {
     "pytorch_project": "tutorials",
-    "canonical_url": "https://github.com/Rose-STL-Lab/torchTS",
+    "canonical_url": "https://rose-stl-lab.github.io/torchTS/docs/",
     "collapse_navigation": False,
     "display_version": True,
     "logo": "_static/images/torchTS_logo.png",

scripts/build_docs.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+# run this script from the project root using `./scripts/build_docs.sh`
+
+echo "-----------------------------------"
+echo "Generating API reference via Sphinx"
+echo "-----------------------------------"
+cd docs || exit
+make html
+cd .. || exit
+
+
+# run script to parse html generated by sphinx
+echo "--------------------------------------------"
+echo "Parsing Sphinx docs and moving to Docusaurus"
+echo "--------------------------------------------"
+mkdir -p "website/static/api/"
+
+cwd=$(pwd)
+SPHINX_HTML_DIR="website/static/api/"
+cp -R "${cwd}/docs/build/html/" "${cwd}/${SPHINX_HTML_DIR}"
+echo "Parsed Sucessfully"
+echo "Moved location: ${SPHINX_HTML_DIR}"

website/.gitignore

@@ -1,8 +1,10 @@
 # Dependencies
 /node_modules
+yarn.lock
 
 # Production
 /build
+/static/api
 
 # Generated files
 .docusaurus

website/docusaurus.config.js

@@ -46,6 +46,11 @@ module.exports = {
           position: "left",
           label: "Docs",
         },
+        {
+          href: "https://rose-stl-lab.github.io/torchTS/api",
+          label: "API Reference",
+          position: "left",
+        },
         {
           href: "https://github.com/Rose-STL-Lab/torchTS",
           label: "GitHub",