summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorDavid Lord <davidism@gmail.com>2022-07-17 08:34:27 -0700
committerDavid Lord <davidism@gmail.com>2022-07-17 09:16:47 -0700
commitda24427dfa65f10fd89ce94d17d47ceba942b4c4 (patch)
tree3f7941cdbd0536a8c417e7ac55d50dc5ecdbd831 /docs/conf.py
parent98948fa75a69c0844ec917aa7c50b9cea5f26216 (diff)
downloadblinker-da24427dfa65f10fd89ce94d17d47ceba942b4c4.tar.gz
update sphinx config
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..5bbd200
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,33 @@
+from pallets_sphinx_themes import get_version
+from pallets_sphinx_themes import ProjectLink
+
+project = "Blinker"
+copyright = "2010 Jason Kirtland"
+release, version = get_version("blinker", placeholder=None)
+
+extensions = [
+ "sphinx.ext.autodoc",
+ "pallets_sphinx_themes",
+]
+
+autoclass_content = "both"
+autodoc_member_order = "groupwise"
+
+html_theme = "flask"
+html_theme_options = {"index_sidebar_logo": False}
+html_context = {
+ "project_links": [
+ ProjectLink("PyPI Releases", "https://pypi.org/project/blinker/"),
+ ProjectLink("Source Code", "https://github.com/pallets-eco/blinker/"),
+ ProjectLink("Issue Tracker", "https://github.com/pallets-eco/blinker/issues/"),
+ ]
+}
+html_sidebars = {
+ "index": ["project.html", "localtoc.html", "searchbox.html", "ethicalads.html"],
+ "**": ["localtoc.html", "relations.html", "searchbox.html", "ethicalads.html"],
+}
+singlehtml_sidebars = {"index": ["project.html", "localtoc.html", "ethicalads.html"]}
+html_static_path = ["_static"]
+html_logo = "_static/blinker-named.png"
+html_title = f"Blinker Documentation ({version})"
+html_show_sourcelink = False