update doc requirements and rtd conf (#165)

.github/workflows/document.yml

@@ -1,42 +0,0 @@
-name: Deploy documentation
-on:
-  pull_request:
-    types: [closed]
-    branches:
-      - '*'
-    paths:
-      - 'docs/**'
-      - 'colossalai/**'
-
-jobs:
-  build:
-    name: Build and deploy documentation
-    runs-on: [self-hosted, gpu]
-    container:
-      image: nvcr.io/nvidia/pytorch:21.07-py3
-      options: --gpus all --rm --ipc=host -v /home/gitact/.ssh:/root/ssh
-    timeout-minutes: 1200
-    if: github.base_ref == 'main' && github.event.pull_request.base.repo.full_name == 'hpcaitech/ColossalAI' && github.event.pull_request.merged == true
-    steps:
-      - name: Setup Environment
-        run: |
-          export https_proxy=http://172.17.0.1:7890 http_proxy=http://172.17.0.1:7890 all_proxy=socks5://172.17.0.1:7890
-          cp -r /root/ssh /root/.ssh
-      - name: Install dependencies
-        run: |
-          pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
-          pip install -U pip setuptools wheel --user
-          pip install pytest tensorboard deepspeed apex sphinx sphinx-rtd-theme myst-parser
-      - uses: actions/checkout@v2
-      - name: Install Colossal-AI
-        run: |
-          pip install -v --no-cache-dir --global-option="--cuda_ext" .
-      - name: Build documentation
-        run: |
-          cd docs
-          rm -rf colossalai
-          make apidoc
-          make html
-      - name: Deploy documentation
-        run: |
-          scp -r docs/.build/html server:/home/shared/web/html/colossalai-doc

.readthedocs.yaml

@@ -0,0 +1,30 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: requirements/requirements.txt
+   - requirements: docs/requirements.txt

docs/conf.py

@@ -6,6 +6,7 @@
 
 # -- Path setup --------------------------------------------------------------
 
+import datetime
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -18,14 +19,13 @@ sys.path.insert(0, os.path.abspath('..'))
 # -- Project information -----------------------------------------------------
 
 project = 'Colossal-AI'
-copyright = '2021, HPC-AI Tech'
+copyright = f'{datetime.datetime.now().year}, HPC-AI Tech'
 author = 'HPC-AI Technology Inc.'
 
 # The full version, including alpha/beta/rc tags
 release = '0.0.1'
 
-if 'SPHINX_LANG' in os.environ:
-    root_doc = f'index_{os.environ["SPHINX_LANG"]}'
+
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -34,8 +34,8 @@ if 'SPHINX_LANG' in os.environ:
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.mathjax',
-    'myst_parser',
     'sphinx.ext.napoleon',
+    'myst_parser',
 ]
 
 # Disable docstring inheritance

docs/requirements.txt

@@ -0,0 +1,6 @@
+tensorboard 
+deepspeed 
+apex 
+sphinx 
+sphinx-rtd-theme 
+myst-parser