Skip to content
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.

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

Use Furo as Sphinx documentation theme #2966

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_static/pelican-logo.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 7 additions & 14 deletions docs/conf.py
Expand Up @@ -3,8 +3,6 @@

from pelican import __version__

on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

sys.path.append(os.path.abspath(os.pardir))

# -- General configuration ----------------------------------------------------
Expand All @@ -24,25 +22,20 @@
.. |last_stable| replace:: :pelican-doc:`{}`
'''.format(last_stable)

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

extlinks = {
'pelican-doc': ('https://docs.getpelican.com/%s/', '')
}

# -- Options for HTML output --------------------------------------------------

html_theme = 'default'
if not on_rtd:
try:
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
except ImportError:
pass

html_theme = 'furo'
html_title = f'<strong>{project}</strong> <i>{release}</i>'
html_static_path = ['_static']
html_theme_options = {
'light_logo': 'pelican-logo.svg',
'dark_logo': 'pelican-logo.svg',
'navigation_with_keys': True,
}

# Output file base name for HTML help builder.
htmlhelp_basename = 'Pelicandoc'
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Expand Up @@ -48,8 +48,8 @@ jinja2 = "~2.11"
lxml = "^4.3"
markdown = "~3.3.4"
typogrify = "^2.0"
sphinx = "^3.0"
sphinx_rtd_theme = "^0.5"
sphinx = "^4.3.0"
furo = "^2022.1.2"
livereload = "^2.6"
psutil = {version = "^5.7", optional = true}
pygments = "~2.8"
Expand Down
2 changes: 1 addition & 1 deletion requirements/docs.pip
@@ -1,3 +1,3 @@
sphinx
sphinx_rtd_theme
furo
livereload