github
/
ColossalAI
mirror of https://github.com/hpcaitech/ColossalAI
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[doc] updated the sphinx theme (#2635)

pull/2637/head
Frank Lee 2023-02-08 13:48:08 +08:00 committed by GitHub
parent 90a9fdd91d
commit d3480396f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/conf.py
View File

@ -23,8 +23,7 @@ copyright = f'{datetime.datetime.now().year}, HPC-AI Tech'
author = 'HPC-AI Technology Inc.' author = 'HPC-AI Technology Inc.'
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = '0.0.1' # release = '0.0.1'
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
@ -64,14 +63,14 @@ exclude_patterns = ['.build', 'Thumbs.db', '.DS_Store']
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = 'sphinx_rtd_theme' html_theme = 'sphinx_book_theme'
html_show_sourcelink = False html_show_sourcelink = False
html_theme_options = { html_theme_options = {
'navigation_depth': 3, 'navigation_depth': 3,
} }
html_context = { html_context = {
'display_github': False, 'display_github': True,
'github_user': 'hpcaitech', 'github_user': 'hpcaitech',
'github_repo': 'ColossalAI', 'github_repo': 'ColossalAI',
# 'github_version': 'master/docs/', # 'github_version': 'master/docs/',
@ -90,7 +89,10 @@ html_css_files = [
source_suffix = ['.rst', '.md', '.MD'] source_suffix = ['.rst', '.md', '.MD']
import inspect import inspect
import colossalai import colossalai
def linkcode_resolve(domain, info): def linkcode_resolve(domain, info):
""" """
Determine the URL corresponding to Python object Determine the URL corresponding to Python object

8
docs/requirements.txt
View File

@ -1,5 +1,5 @@
tensorboard tensorboard
apex apex
sphinx sphinx
sphinx-rtd-theme
myst-parser myst-parser
sphinx-book-theme