Skip to content

Commit

Permalink
chore(docs): switch to furo sphinx theme (#141)
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexMeier99 authored Oct 26, 2024
1 parent d631f40 commit 0ac3a52
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
14 changes: 10 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'numpydoc',
'sphinxext.opengraph',
'sphinx_copybutton'
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -65,7 +67,7 @@

# General information about the project.
project = u'selectolax'
copyright = u"2018-2023, Artem Golubin"
copyright = u"2018-2024, Artem Golubin"

# The version info for the project you're documenting, acts as replacement
# for |version| and |release|, also used in various other places throughout
Expand Down Expand Up @@ -121,12 +123,16 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# html_theme = 'default'
html_theme = 'sphinx_rtd_theme'
html_theme = 'furo'

# 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 = {
"source_repository": "https://github.com/rushter/selectolax",
"source_branch": "master",
"source_directory": "docs/",
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
Expand All @@ -141,7 +147,7 @@

# The name of an image file (relative to this directory) to place at the
# top of the sidebar.
# html_logo = None
html_logo = "logo.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
Expand Down
6 changes: 4 additions & 2 deletions requirements_dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ flake8>=2.6.0
tox>=2.3.1
coverage>=4.1
Sphinx==8.0.2
sphinx-rtd-theme==3.0.0
numpydoc==1.8.0
pytest>=3.7.2
pytest-runner>=4.2
Cython>=3.0.11
pluggy>=0.7.1
mypy==1.4.1
types-pyinstaller==6.10.0.20240812
types-pyinstaller==6.10.0.20240812
furo==2024.8.6
sphinxext-opengraph==0.9.1
sphinx-copybutton==0.5.2

0 comments on commit 0ac3a52

Please sign in to comment.