updating bastille docs theme & options; adding logo

This commit is contained in:
Christer Edwards
2025-06-15 19:12:22 -07:00
parent 8f3e3e951d
commit f8dc301942
3 changed files with 22 additions and 11 deletions

View File

@@ -1,10 +1,3 @@
import os
on_rtd = os.environ.get('READTHEDOCS') == 'True'
if on_rtd:
html_theme = 'default'
else:
html_theme = 'sphinx_rtd_theme'
# -- Project information -----------------------------------------------------
project = 'Bastille'
@@ -16,11 +9,9 @@ version = '0.14.20250420'
# The full version, including alpha/beta/rc tags
release = '0.14.20250420-beta'
# -- General configuration ---------------------------------------------------
extensions = [
]
extensions = ['sphinx_rtd_theme']
templates_path = ['_templates']
@@ -37,9 +28,27 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
pygments_style = None
# -- Options for HTML output -------------------------------------------------
html_logo = 'images/bastille.jpeg'
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
html_theme_options = {
'logo_only': False,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
'vcs_pageview_mode': '',
'style_nav_header_background': 'white',
'flyout_display': 'hidden',
'version_selector': True,
'language_selector': True,
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'titles_only': False
}
# -- Options for HTMLHelp output ---------------------------------------------
htmlhelp_basename = 'Bastilledoc'

BIN
docs/images/bastille.jpeg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View File

@@ -1 +1,3 @@
docutils < 0.18
sphinx
sphinx_rtd_theme