[doc] removed read-the-docs (#2932)

docs/colossalai/colossalai.zero.sharded_param.sharded_tensor.rst

-colossalai.zero.sharded\_param.sharded\_tensor
-==============================================
-
-.. automodule:: colossalai.zero.sharded_param.sharded_tensor
-   :members:

docs/colossalai/colossalai.zero.utils.rst

-colossalai.zero.utils
-=====================
-
-.. automodule:: colossalai.zero.utils
-   :members:
-
-
-.. toctree::
-   :maxdepth: 2
-
-   colossalai.zero.utils.zero_hook
-   colossalai.zero.utils.gemini_hook

docs/colossalai/colossalai.zero.utils.zero_hook.rst

-colossalai.zero.utils.zero\_hook
-================================
-
-.. automodule:: colossalai.zero.utils.zero_hook
-   :members:

docs/colossalai/colossalai.zero.utils.zero_hook_v2.rst

-colossalai.zero.utils.zero\_hook\_v2
-====================================
-
-.. automodule:: colossalai.zero.utils.gemini_hook
-   :members:

docs/colossalai/colossalai.zero.zero_optimizer.rst

-colossalai.zero.zero\_optimizer
-===============================
-
-.. automodule:: colossalai.zero.zero_optimizer
-   :members:

docs/conf.py

-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- 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.
-#
-import os
-import sys
-
-sys.path.insert(0, os.path.abspath('..'))
-
-# -- Project information -----------------------------------------------------
-
-project = 'Colossal-AI'
-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'
-
-# -- General configuration ---------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.linkcode',
-    'myst_parser',
-]
-
-# Disable docstring inheritance
-autodoc_inherit_docstrings = False
-
-# Disable displaying type annotations, these can be very verbose
-autodoc_typehints = 'none'
-
-# Enable overriding of function signatures in the first line of the docstring.
-autodoc_docstring_signature = True
-autodoc_default_options = {
-    'member-order': 'bysource',
-}
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['.build', 'Thumbs.db', '.DS_Store']
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = 'sphinx_book_theme'
-html_show_sourcelink = False
-html_theme_options = {
-    'navigation_depth': 3,
-}
-
-html_context = {
-    'display_github': True,
-    'github_user': 'hpcaitech',
-    'github_repo': 'ColossalAI',
-    #   'github_version': 'master/docs/',
-}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-html_css_files = [
-    'css/rtd_theme.css',
-]
-
-# -- Extension configuration -------------------------------------------------
-source_suffix = ['.rst', '.md', '.MD']
-
-import inspect
-
-import colossalai
-
-
-def linkcode_resolve(domain, info):
-    """
-    Determine the URL corresponding to Python object
-    """
-    if domain != 'py':
-        return None
-
-    modname = info['module']
-    fullname = info['fullname']
-
-    submod = sys.modules.get(modname)
-    if submod is None:
-        return None
-
-    obj = submod
-    for part in fullname.split('.'):
-        try:
-            obj = getattr(obj, part)
-        except Exception:
-            return None
-
-    try:
-        fn = inspect.getsourcefile(obj)
-    except Exception:
-        fn = None
-    if not fn:
-        return None
-
-    try:
-        source, lineno = inspect.findsource(obj)
-    except Exception:
-        lineno = None
-
-    if lineno:
-        linespec = "#L%d" % (lineno + 1)
-    else:
-        linespec = ""
-
-    fn = os.path.relpath(fn, start=os.path.dirname(colossalai.__file__))
-
-    github = "https://github.com/hpcaitech/ColossalAI/blob/main/colossalai/{}{}"
-    return github.format(fn, linespec)

docs/index.rst

-.. Colossal-AI documentation master file, created by
-   sphinx-quickstart on Mon Oct 11 17:05:05 2021.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Colossal-AI API documentation
-======================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: API REFERENCE
-
-   colossalai/colossalai
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Useful links for Colossal-AI
-
-   links/Colossalai examples
-   links/Colossalai benchmarks
-   links/Colossalai tutorial
-
-
-Indices and tables
---------------------
-
-* :ref:`genindex`

docs/links/Colossalai Homepage.rst

-Colossal-AI Github Homepage
-==================================
-
-*If you are looking for the Git homepage of Colossal-AI, please check*
-`Colossal-AI Tutorial <https://github.com/hpcaitech/ColossalAI>`_
-*for our source code.*
\ No newline at end of file

docs/links/Colossalai benchmarks.rst

-Colossal-AI Benchmarks
-==================================
-
-*If you are interested in the performance or the features of Colossal-AI, please check*
-`Colossal-AI Benchmark <https://github.com/hpcaitech/ColossalAI-Benchmark>`_.
-*to get more details about our performance on CIFAR10, ImageNet1K or GPT2 ZeRO.*
\ No newline at end of file

docs/links/Colossalai examples.rst

-Colossal-AI Examples
-==================================
-
-*If you are looking for the example code of using Colossal-AI in CV or NLP, please check*
-`Colossal-AI Example <https://github.com/hpcaitech/ColossalAI-Examples>`_
-*to get more details about using colossalai in Resnet, Moe, Vit, Bert and GPT*
\ No newline at end of file

docs/links/Colossalai tutorial.rst

-Colossal-AI Tutorial
-==================================
-
-*If you are looking for the tutorial of using Colossal-AI, please check*
-`Colossal-AI Tutorial <https://www.colossalai.org/docs/get_started/installation>`_
-*to get more details about getting started, using TP (tensor parallel), PP (pipeline parallel)
-and training with colossalai trainer or engine.*
\ No newline at end of file

docs/make.bat

-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=.build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.https://www.sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd

docs/requirements.txt

-tensorboard
-apex
-sphinx
-myst-parser
-sphinx-book-theme