Skip to content

Commit

Permalink
Update docs setup
Browse files Browse the repository at this point in the history
  • Loading branch information
Secrus committed Feb 20, 2024
1 parent bfe1219 commit 20d8a2f
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 55 deletions.
20 changes: 1 addition & 19 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "default"
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
Expand Down Expand Up @@ -255,21 +255,3 @@

# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False


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

if not on_rtd:
html_theme = "sphinx_rtd_theme"

def setup(app):
app.add_css_file("theme_overrides.css")

else:
html_context = {
"css_files": [
"https://media.readthedocs.org/css/sphinx_rtd_theme.css",
"https://media.readthedocs.org/css/readthedocs-doc-embed.css",
"_static/theme_overrides.css",
]
}
98 changes: 64 additions & 34 deletions poetry.lock

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

4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ pytest-mock = "^3.8.2"
towncrier = ">=22.12.0"

[tool.poetry.group.doc.dependencies]
Sphinx = "^5.2.3"
sphinx-rtd-theme = "^1.0.0"
sphinx = "^7.1"
furo = "^2023.9.10"

[tool.ruff]
fix = true
Expand Down

0 comments on commit 20d8a2f

Please sign in to comment.