Skip to content

DOC: use furo theme #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
hagenw wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

DOC: use furo theme #323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
752b753
Use furo theme
hagenw Aug 2, 2023
946ad55
Add logos
hagenw Dec 21, 2023
fdc3bbe
Start fine-tuning
hagenw Dec 22, 2023
c910974
Further color tweaks
hagenw Dec 22, 2023
3b87c12
Fix link colors
hagenw Dec 22, 2023
da7eb44
Use red logo
hagenw Dec 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_static/logo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
86 changes: 80 additions & 6 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
copyright = f'2020-{date.today().year} audEERING GmbH'
author = ', '.join(author['name'] for author in config['project']['authors'])
version = audeer.git_repo_version()
title = 'Documentation'
title = project


# General -----------------------------------------------------------------
Expand Down Expand Up @@ -78,12 +78,86 @@
toc_object_entries = False

# HTML --------------------------------------------------------------------
html_theme = 'sphinx_audeering_theme'
html_theme = 'furo'
html_static_path = ['_static']
html_theme_options = {
'display_version': True,
'logo_only': False,
'wide_pages': ['data-example'],
'footer_links': False,
'source_repository': 'https://github.com/audeering/audb',
'source_branch': 'main',
'source_directory': 'docs/',
# Logo
'light_logo': 'logo.png',
'dark_logo': 'logo.png',
# Colors
'light_css_variables': {
'color-brand-primary': '#e13b41',
'color-brand-content': '#3c4350',
'color-code-foreground': '#3c4350',
'color-code-background': '#f7f7fd',
'color-content-foreground': '#3c4350',
'color-sidebar-background': '#ffffff',
'color-sidebar-search-background': '#ffffff',
'color-api-pre-name': '#e13b41',
'color-api-name': '#e13b41',
'color-api-overall': '#5d6370',
'color-api-background-hover': '#f7f7fd',
'color-link': '#e13b41',
'color-link--hover': '#e13b41',
'color-link-underline': '#d6d7e5',
'color-link-underline--hover': '#e13b41',
'color-inline-code-background': '#f7f7fd',
'color-admonition-title--caution': '#f0aa3a',
'color-admonition-title-background--caution': 'rgba(240,170,58,.2)',
'color-admonition-title--warning': 'f0aa3a',
'color-admonition-title-background--warning': 'rgba(240,170,58,.2)',
'color-admonition-title--danger': '#e94274',
'color-admonition-title-background--danger': 'rgba(233,66,116,.2)',
'color-admonition-title--attention': '#e94274',
'color-admonition-title-background--attention': 'rgba(233,66,116,.2)',
'color-admonition-title--error': '#e94274',
'color-admonition-title-background--error': 'rgba(233,66,116,.2)',
'color-admonition-title--hint': '#35e17a',
'color-admonition-title-background--hint': 'rgba(53,255,122,.2)',
'color-admonition-title--tip': '#35e17a',
'color-admonition-title-background--tip': 'rgba(53,255,122,.2)',
'color-admonition-title--important': '#f0aa3a',
'color-admonition-title-background--important': 'rgba(240,170,58,.2)',
'color-admonition-title--note': '#32adf2',
'color-admonition-title-background--note': 'rgba(50,173,242,.2)',
'color-admonition-title--seealso': '#32adf2',
'color-admonition-title-background--seealso': 'rgba(50,173,242,.2)',
'color-admonition-title--todo': '#32adf2',
'color-admonition-title-background--todo': 'rgba(50,173,242,.2)',
# 'color-admonition-title': '',
# 'color-admonition-title-background': '',
# TODO:
# * color of code listings has to be set in CSS
# by using:
# .highlight {
# background: #f7f7d;
# }
# * adjust size of headings:
# h1 {
# font-size: 2.25em;
# }
# h2 {
# font-size: 1.75em;
# }
#
# * disable border of inline code,
# and adjust padding for missing border:
# p .sig-inline, p code.literal {
# border: none;
# }
# .sig-inline, code.literal {
# padding: 0.15em 0.25em;
# }
#
# * center sidebar title
# .sidebar-brand-text {
# text-align: center;
# }
'font-stack': 'Open Sans, sans-serif',
}
}
html_context = {
'display_github': True,
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
docutils
furo
ipykernel
jupyter-sphinx
sphinx >=3.5.4
sphinx-audeering-theme >=1.2.1
sphinx-autodoc-typehints
sphinx-copybutton
toml