Browse Source

[doc] updated the sphinx theme (#2635)

pull/2637/head
Frank Lee 2 years ago committed by GitHub
parent
commit
d3480396f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 10
      docs/conf.py
  2. 8
      docs/requirements.txt

10
docs/conf.py

@ -23,8 +23,7 @@ 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'
# release = '0.0.1'
# -- 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
# 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 @@ html_css_files = [
source_suffix = ['.rst', '.md', '.MD']
import inspect
import colossalai
def linkcode_resolve(domain, info):
"""
Determine the URL corresponding to Python object

8
docs/requirements.txt

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

Loading…
Cancel
Save