Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
ColossalAI
Commits
1949d3a8
Unverified
Commit
1949d3a8
authored
Jan 19, 2022
by
ver217
Committed by
GitHub
Jan 19, 2022
Browse files
update doc requirements and rtd conf (#165)
parent
be85a0f3
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
40 additions
and
46 deletions
+40
-46
.github/workflows/document.yml
.github/workflows/document.yml
+0
-42
.readthedocs.yaml
.readthedocs.yaml
+30
-0
docs/conf.py
docs/conf.py
+4
-4
docs/requirements.txt
docs/requirements.txt
+6
-0
No files found.
.github/workflows/document.yml
deleted
100644 → 0
View file @
be85a0f3
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 → 100644
View file @
1949d3a8
# .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
\ No newline at end of file
docs/conf.py
View file @
1949d3a8
...
...
@@ -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 → 100644
View file @
1949d3a8
tensorboard
deepspeed
apex
sphinx
sphinx-rtd-theme
myst-parser
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment