mirror of
https://github.com/hackacad/bastille.git
synced 2025-12-16 15:20:38 +01:00
updating bastille docs theme & options; adding logo
This commit is contained in:
31
docs/conf.py
31
docs/conf.py
@@ -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 information -----------------------------------------------------
|
||||||
|
|
||||||
project = 'Bastille'
|
project = 'Bastille'
|
||||||
@@ -16,11 +9,9 @@ version = '0.14.20250420'
|
|||||||
# The full version, including alpha/beta/rc tags
|
# The full version, including alpha/beta/rc tags
|
||||||
release = '0.14.20250420-beta'
|
release = '0.14.20250420-beta'
|
||||||
|
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
# -- General configuration ---------------------------------------------------
|
||||||
|
|
||||||
extensions = [
|
extensions = ['sphinx_rtd_theme']
|
||||||
]
|
|
||||||
|
|
||||||
templates_path = ['_templates']
|
templates_path = ['_templates']
|
||||||
|
|
||||||
@@ -37,9 +28,27 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|||||||
pygments_style = None
|
pygments_style = None
|
||||||
|
|
||||||
# -- Options for HTML output -------------------------------------------------
|
# -- Options for HTML output -------------------------------------------------
|
||||||
|
html_logo = 'images/bastille.jpeg'
|
||||||
|
html_theme = 'sphinx_rtd_theme'
|
||||||
html_static_path = ['_static']
|
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 ---------------------------------------------
|
# -- Options for HTMLHelp output ---------------------------------------------
|
||||||
|
|
||||||
htmlhelp_basename = 'Bastilledoc'
|
htmlhelp_basename = 'Bastilledoc'
|
||||||
|
|||||||
BIN
docs/images/bastille.jpeg
Normal file
BIN
docs/images/bastille.jpeg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
@@ -1 +1,3 @@
|
|||||||
docutils < 0.18
|
docutils < 0.18
|
||||||
|
sphinx
|
||||||
|
sphinx_rtd_theme
|
||||||
|
|||||||
Reference in New Issue
Block a user