Skip to content

Commit

Permalink
Update website theme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeffwan committed Sep 12, 2024
1 parent abad5dc commit 11a685d
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 6 deletions.
6 changes: 6 additions & 0 deletions docs/requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
sphinx==8.0.2
sphinx-book-theme==1.1.3
sphinx-click==6.0.0
sphinx-copybutton==0.5.2
sphinx-togglebutton==0.3.2
sphinxemoji==0.3.1
sphinx-autodoc-typehints-2.4.1==2.4.1
sphinx_design==0.6.1
61 changes: 55 additions & 6 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,77 @@

project = 'AIBrix'
copyright = '2024, AIBrix Team'
author = 'AIBrix Team'
release = '0.1.0'
author = 'the AIBrix Authors'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []
extensions = [
'sphinxemoji.sphinxemoji',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinx_autodoc_typehints',
'sphinx_click',
'sphinx_copybutton',
'sphinx_design',
'myst_parser',
]

templates_path = ['_templates']
exclude_patterns = []


# Exclude the prompt "$" when copying code
copybutton_prompt_text = r"\$ "
copybutton_prompt_is_regexp = True


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_title = project
html_theme = 'sphinx_book_theme'
html_logo = 'aibrix_icon.png'
html_static_path = ['_static']
html_theme_options = {
# repository level setting
'repository_url': 'https://github.com/aibrix/aibrix',
"use_repository_button": True,
"repository_branch": "main",
'path_to_docs': 'docs/source',

# theme
'pygment_light_style': 'tango',
'pygment_dark_style': 'monokai',


html_theme_options = {
'navigation_depth': 4,
# navigation and sidebar
'show_toc_level': 1,
'announcement': 'This is still in private mode',
'secondary_sidebar_items': [
'page-toc',
],
'navigation_depth': 3,
'primary_sidebar_end': [],

# article

# footer
'footer_start': [],
'footer_center': [],
'footer_end': [],
}

intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"typing_extensions":
("https://typing-extensions.readthedocs.io/en/latest", None),
"pillow": ("https://pillow.readthedocs.io/en/stable", None),
"numpy": ("https://numpy.org/doc/stable", None),
"torch": ("https://pytorch.org/docs/stable", None),
"psutil": ("https://psutil.readthedocs.io/en/stable", None),
}

0 comments on commit 11a685d

Please sign in to comment.