Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[doc] updated the sphinx theme #2635

Merged
merged 1 commit into from
Feb 8, 2023
Merged

[doc] updated the sphinx theme #2635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@
author = 'HPC-AI Technology Inc.'

# The full version, including alpha/beta/rc tags
release = '0.0.1'

# release = '0.0.1'

# -- General configuration ---------------------------------------------------

Expand Down Expand Up @@ -64,14 +63,14 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'sphinx_book_theme'
html_show_sourcelink = False
html_theme_options = {
'navigation_depth': 3,
}

html_context = {
'display_github': False,
'display_github': True,
'github_user': 'hpcaitech',
'github_repo': 'ColossalAI',
# 'github_version': 'master/docs/',
Expand All @@ -90,7 +89,10 @@
source_suffix = ['.rst', '.md', '.MD']

import inspect

import colossalai


def linkcode_resolve(domain, info):
"""
Determine the URL corresponding to Python object
Expand Down
8 changes: 4 additions & 4 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
tensorboard
apex
sphinx
sphinx-rtd-theme
tensorboard
apex
sphinx
myst-parser
sphinx-book-theme