Skip to content

Commit a7a097c

Browse files
committed
changed docs theme to alabaster and customized to have TOC and full width (no margins)
1 parent 70a2fb2 commit a7a097c

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

doc/conf.py

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,17 +81,38 @@ def extract_version(filename: str):
8181
# The theme to use for HTML and HTML Help pages. See the documentation for
8282
# a list of builtin themes.
8383

84-
html_theme = "sphinx_rtd_theme"
85-
# html_theme = 'alabaster'
84+
# html_theme = "pyramid"
85+
# html_theme = "sphinx_rtd_theme"
86+
html_theme = 'alabaster'
8687
# html_theme = "classic"
8788

89+
# Alabaster theme options
90+
html_theme_options = {
91+
'page_width': '100%', # Use full width of browser
92+
'body_max_width': 'none', # No maximum width constraint
93+
'sidebar_width': '300px', # Set sidebar width to 300px (adjust as needed)
94+
'fixed_sidebar': True # Make sidebar fixed with separate scrolling
95+
}
96+
97+
8898
# Add any paths that contain custom static files (such as style sheets) here,
8999
# relative to this directory. They are copied after the builtin static files,
90100
# so a file named "default.css" will overwrite the builtin "default.css".
91-
html_static_path = []
101+
html_static_path = ['_static']
102+
html_css_files = ['custom.css']
103+
104+
html_sidebars = {
105+
'**': [
106+
'globaltoc.html', # Global table of contents
107+
'localtoc.html', # Local page table of contents
108+
'searchbox.html', # Search box
109+
'sourcelink.html' # Link to source
110+
]
111+
}
92112

93113
# use order in source rather than alphabetical order
94-
autodoc_member_order = 'bysource'
114+
# autodoc_member_order = 'bysource'
115+
autodoc_member_order = 'alphabetical'
95116

96117
# intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
97118

0 commit comments

Comments
 (0)