[doc] updated the sphinx theme (#2635)

hpcaitech · Feb 8, 2023 · d348039 · d348039
1 parent 90a9fdd
commit d348039
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -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 ---------------------------------------------------
 
@@ -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/',
@@ -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

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,5 @@
-tensorboard 
-apex 
-sphinx 
-sphinx-rtd-theme 
+tensorboard
+apex
+sphinx
 myst-parser
+sphinx-book-theme