Skip to content

Commit

Permalink
Switch to PyData Sphinx theme
Browse files Browse the repository at this point in the history
  • Loading branch information
speth committed Aug 9, 2023
1 parent 277bce0 commit f3fe297
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 217 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/main.yml
Expand Up @@ -326,7 +326,8 @@ jobs:
- name: Install Python dependencies
run: |
python3 -m pip install ruamel.yaml scons numpy cython sphinx==5.1.1 \
sphinxcontrib-katex sphinxcontrib-matlabdomain sphinxcontrib-doxylink pint
sphinxcontrib-katex sphinxcontrib-matlabdomain sphinxcontrib-doxylink pint \
pydata-sphinx-theme==0.13.3
- name: Build Cantera with documentation
run: python3 `which scons` build -j2 doxygen_docs=y sphinx_docs=y debug=n optimize=n use_pch=n
- name: Ensure 'scons help' options work
Expand Down
162 changes: 0 additions & 162 deletions doc/sphinx/_templates/layout.html

This file was deleted.

38 changes: 6 additions & 32 deletions doc/sphinx/conf.py
Expand Up @@ -167,43 +167,17 @@ def escape_splats(app, what, name, obj, options, lines):

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'cttheme'
html_sidebars = {
'**': ['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html', 'numfocus.html'],
}
html_theme = 'pydata_sphinx_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.

# Copy the Bootstrap 4 font families.
font_families = [
# Default on Apple
'-apple-system',
# Default for older versions of Chrome on Mac
'BlinkMacSystemFont',
# Windows
'"Segoe UI"',
# Android
'Roboto',
# Standard fallbacks
'"Helvetica Neue"', 'Arial', 'sans-serif',
# Emoji fonts
'"Apple Color Emoji"', '"Segoe UI Emoji"', '"Segoe UI Symbol"']

code_font_families = [
'SFMono-Regular',
'Menlo',
'Monaco',
'Consolas',
'"Liberation Mono"',
'"Courier New"', 'monospace'
]
html_theme_options = {
'font_family': ','.join(font_families),
'head_font_family': ','.join(font_families),
'caption_font_family': ','.join(font_families),
'code_font_family': ','.join(code_font_families),
"show_toc_level": 2,
"logo": {
"text": "Cantera",
},
}

# Add any paths that contain custom themes here, relative to this directory.
Expand All @@ -218,7 +192,7 @@ def escape_splats(app, what, name, obj, options, lines):

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
html_logo = '_static/images/cantera-icon.png'

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
Expand Down
19 changes: 0 additions & 19 deletions doc/sphinx/cttheme/static/cantera.css

This file was deleted.

3 changes: 0 additions & 3 deletions doc/sphinx/cttheme/theme.conf

This file was deleted.

0 comments on commit f3fe297

Please sign in to comment.