Skip to content

Commit

Permalink
Merge pull request #52 from AstarVienna/fh/rtdtheme
Browse files Browse the repository at this point in the history
Use sphinx-book-theme
  • Loading branch information
teutoburg authored Jan 27, 2024
2 parents e196671 + 16b4563 commit 666b8ed
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 18 deletions.
20 changes: 12 additions & 8 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,13 +97,19 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
# html_theme = 'classic'
html_theme = "sphinx_book_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.
#
# html_theme_options = {}
html_theme_options = {
"repository_url": "https://github.com/AstarVienna/skycalc_ipy",
"use_repository_button": True,
"home_page_in_toc": True,
}
html_logo = "_static/logos/logo_skycalc_ipy_t.png"
html_title = "skycalc_ipy"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand All @@ -112,13 +118,11 @@

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
"**": [
"navbar-logo.html",
"search-field.html",
"sbt-sidebar-nav.html",
]
}

Expand Down
62 changes: 53 additions & 9 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ optional = true

[tool.poetry.group.docs.dependencies]
sphinx = "^5.3.0"
sphinx-rtd-theme = "^0.5.1"
sphinx-book-theme = "^1.1.0"
jupyter-sphinx = "^0.2.3"
sphinxcontrib-apidoc = "^0.4.0"
nbsphinx = "^0.9.3"
Expand Down

0 comments on commit 666b8ed

Please sign in to comment.