docs get correct release version (#489)

pull/491/head
ver217 2022-03-22 14:24:41 +08:00 committed by GitHub
parent d7ea63992b
commit 9caa8b6481
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 5 deletions

View File

@ -16,6 +16,12 @@ import sys
sys.path.insert(0, os.path.abspath('..')) sys.path.insert(0, os.path.abspath('..'))
def get_version():
with open('../version.txt') as f:
return f.read().strip()
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'Colossal-AI' project = 'Colossal-AI'
@ -23,8 +29,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 = get_version()
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
@ -46,9 +51,7 @@ autodoc_typehints = 'none'
# Enable overriding of function signatures in the first line of the docstring. # Enable overriding of function signatures in the first line of the docstring.
autodoc_docstring_signature = True autodoc_docstring_signature = True
autodoc_default_options = { autodoc_default_options = {'member-order': 'bysource'}
'member-order': 'bysource'
}
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']